Viewing File: /usr/local/cpanel/whostmgr/docroot/openapi/cpanel.openapi.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf8" />
<title>cPanel UAPI</title>
<!-- needed for adaptive design -->
<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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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's features' 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'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'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'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' 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'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'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'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 & 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'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 & 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'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'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' 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' 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' 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' 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' 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' 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' 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' 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' 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' 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' 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'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'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' 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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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'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' 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'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'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'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'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'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'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'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'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'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'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'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' 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'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' 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'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'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'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'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'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'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'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'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'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'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'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'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'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' 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="<p>UAPI accesses the cPanel interface&#39;s features. Use this API to access and modify cPanel account data and settings.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>UAPI accesses the cPanel interface'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="<p>API Development Tools / API Token Management</p>
"><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a new API token with full access to all of a cPanel account'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'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"> <!-- --><<!-- -->unix_timestamp<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token'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"> <!-- --><= 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create_full_access"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Tokens"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"JPQNSRU0DH448UJLGXH7KVJECC5QN9N9"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function returns a list of a cPanel account&#39;s API tokens.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of a cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Tokens"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"exampletoken"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's name<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function renames a cPanel account&#39;s existing API token.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function renames a cPanel account'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="<p>The API token&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token'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"> <!-- --><= 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"rename"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Tokens"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function removes an API token from a cPanel account.</p>
" 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="<p>The API token to remove.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"revoke"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Tokens"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>The Batch module for UAPI.</p>
"><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="<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>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"strict"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Batch"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>API Development Tools / SSE Task Management</p>
"><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="<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>
" 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 >> Home >> Files >> 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="<p>The task&#39;s ID number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The task'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"UserTasks"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a cPanel account'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 >> Home >> Files >> 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"retrieve"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"UserTasks"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"create"</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">"00000000\\/5a9ec8dd4c345d"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subsystem"</span>: <span class="token string">"VersionControl"</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">"create"</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">"/home/user/public_html/example"</span></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">"00000000/h39dnn27suc13l"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subsystem"</span>: <span class="token string">"VersionControl"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>API Development Tools / URL Parsing</p>
"><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="<p>This function returns the URL for an integrated application.</p>
" 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="<p>The application&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"fetch_url"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Integration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"</span><a href="http://application.example.com/application">http://application.example.com/application</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"</span><a href="http://application.example.com/">http://application.example.com/</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function reports the first file&#39;s URI, relative to the cPanel base directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function reports the first file'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"firstfile_relative_uri"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Parser"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/usr/local/cpanel/base/favicon.ico"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>Authentication / External Authentication</p>
"><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="<p>This function adds an External Authentication authorization link to an account.</p>
" 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="<p>The preferred username of the account on the identity provider.</p>
" 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="<p>The name of the identity provider.</p>
" 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="<p>The unique identifier for the user at the identity provider.</p>
" 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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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="<p>The username.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_authn_link"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ExternalAuthentication"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's external authentication providers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the display information for your server&#39;s available and configured external authentication identity provider modules.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the display information for your server'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"configured_modules"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ExternalAuthentication"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"00aef0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"cPanel ID"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentation_url"</span>: <span class="token string">"</span><a href="https://go.cpanel.net/OpenIDConnect">https://go.cpanel.net/OpenIDConnect</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <span class="token string">"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=="</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_type"</span>: <span class="token string">"image/svg+xml"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">"Log in with a cPanel ID Account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"link"</span>: <span class="token string">"</span><a href="https://hostname.example.com:2083/openid_connect/cpanelid">https://hostname.example.com:2083/openid_connect/cpanelid</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">"cpanelid"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"textcolor"</span>: <span class="token string">"FFFFFF"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function determines whether the user enabled external authentication modules.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"has_external_auth_modules_configured"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ExternalAuthentication"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function removes a link to an account at an external authentication identity provider.</p>
" 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="<p>The name of the identity provider.</p>
" 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="<p>The unique identifier for the user at the identity provider.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"remove_authn_link"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ExternalAuthentication"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function lists the external authentication links to the current cPanel account.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_authn_links"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ExternalAuthentication"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"username@gmail.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_id"</span>: <span class="token string">"google"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_protocol"</span>: <span class="token string">"openid_connect"</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="<p>Authentication / Two-Factor Settings</p>
"><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="<p>This function generates an authentication code to enable configuration of two-factor authentication.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"generate_user_configuration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"TwoFactorAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"otpauth://totp/Example%20cPanel%20L.L.C.:fakedomain?secret=S3I4WUY7MTHRMMWN&issuer=Example%20cPanel%20L.L.C."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"secret"</span>: <span class="token string">"S3I4WUY7MTHRMMWN"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a <a href="https://go.cpanel.net/manage-team">team user'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The team user's username.</p>
<p><strong>Note:</strong></p>
<p>The username will always precede the cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_team_user_configuration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"TwoFactorAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"Example WebPros International, LLC"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function retrieves the cPanel account user&#39;s configuration settings for two-factor authentication.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the cPanel account user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_user_configuration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"TwoFactorAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"Example WebPros International, LLC"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function configures the two-factor authentication settings for an account.</p>
" 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"> <!-- --><= 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="<p>The 16-character string that UAPI&#39;s <code>TwoFactorAuth::generate_user_configuration</code> function generates.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 16-character string that UAPI'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"> <!-- --><= 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="<p>The six-digit security code that the time-based one-time password (TOTP) authentication app generates.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_user_configuration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"TwoFactorAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>This function removes the user from the two-factor authentication <code>userdata</code> file.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"remove_user_configuration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"TwoFactorAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>Block Ip Addresses / Block IP</p>
"><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's block list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>The IP address or IP address range that you wish to block.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_ip"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BlockIP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"1.1.1.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/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's block list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>The IP address or IP address range that you wish to unblock.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"remove_ip"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BlockIP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"1.1.1.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/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="<p>Commerce Integration / Market Integration</p>
"><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's available products<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists all products available through all enabled cPanel Market providers.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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="<p>product_group=ssl_certificate</p>
" 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">"get_all_products"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Market"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"billing_type"</span>: <span class="token string">"one-time"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"An extended-validated (EV) SSL certificate signed by COMODO."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"Comodo EV SSL Certificate"</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">"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg=="</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">"image/svg+xml"</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">"USD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product"</span>: <span class="token string">"Comodo EV Certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_category"</span>: <span class="token string">"N/A"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_group"</span>: <span class="token string">"ssl_certificate"</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">"cPanel Store"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">"cPStore"</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">"year"</span></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">"Organization Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"organizationName"</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">"Department Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"organizationalUnitName"</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">"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))"</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">"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"duns_number"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pattern"</span>: <span class="token string">"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"</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">"Street Address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"streetAddress"</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">"City"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"localityName"</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">"State or Province"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"stateOrProvinceName"</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">"Postal Code"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"postalCode"</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">"Country Code"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"countryName"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"country_code"</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">"Representative’s Given (First) Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_forename"</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">"Representative’s Surname (Last Name)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_surname"</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">"Representative’s Email Address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_email_address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"email"</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">"This should be one of the organization’s publicly-listed telephone numbers."</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">"Representative’s Telephone Number"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_telephone"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"tel"</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">"Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">"Business Category"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"business_category"</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">"b"</span>,</div></li><li><div class="hoverable "><span class="token string">"Incorporated Business (“Private Organization”)"</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">"d"</span>,</div></li><li><div class="hoverable "><span class="token string">"Non-incorporated Business (“Business Entity”)"</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">"c"</span>,</div></li><li><div class="hoverable "><span class="token string">"Government Entity (“Government Entity”)"</span></div></li></ul><span class="token punctuation">]</span></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">"choose_one"</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">"City Where Incorporated (JOI (Jurisdiction of Incorporation))"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"joi_locality_name"</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">"State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"joi_state_or_province_name"</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">"Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"joi_country_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"country_code"</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">"Date of Incorporation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"date_of_incorporation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"date"</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">"Assumed Name (DBA (Doing Business As))"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"assumed_name"</span></div></li></ul><span class="token punctuation">}</span></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">"checkout"</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">"ev"</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">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"billing_type"</span>: <span class="token string">"one-time"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"An organization-validated (OV) SSL certificate signed by COMODO."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"Comodo OV SSL Certificate"</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">"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg=="</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">"image/svg+xml"</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">"USD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product"</span>: <span class="token string">"Comodo OV Certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_category"</span>: <span class="token string">"N/A"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_group"</span>: <span class="token string">"ssl_certificate"</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">"cPanel Store"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">"cPStore"</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">"year"</span></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">"Organization Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"organizationName"</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">"Department Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"organizationalUnitName"</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">"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))"</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">"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"duns_number"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pattern"</span>: <span class="token string">"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"</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">"Street Address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"streetAddress"</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">"City"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"localityName"</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">"State or Province"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"stateOrProvinceName"</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">"Postal Code"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"postalCode"</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">"Country Code"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"countryName"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"country_code"</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">"Representative’s Given (First) Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_forename"</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">"Representative’s Surname (Last Name)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_surname"</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">"Representative’s Email Address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_email_address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"email"</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">"This should be one of the organization’s publicly-listed telephone numbers."</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">"Representative’s Telephone Number"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_telephone"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"tel"</span></div></li></ul><span class="token punctuation">}</span></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">"checkout"</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">"150.00"</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">"1500.00"</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">"150.00"</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">"ov"</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">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"billing_type"</span>: <span class="token string">"one-time"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"A domain-validated (DV) SSL certificate signed by cPanel."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"cPanel DV SSL Certificate"</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">"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo="</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">"image/svg+xml"</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">"USD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product"</span>: <span class="token string">"cPanel DV Certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_category"</span>: <span class="token string">"N/A"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_group"</span>: <span class="token string">"ssl_certificate"</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">"cPanel Store"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">"cPStore"</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">"year"</span></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">"issuance"</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">"75.00"</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">"750.00"</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">"75.00"</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">"dv"</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">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"billing_type"</span>: <span class="token string">"one-time"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"An organization-validated (OV) SSL certificate signed by cPanel."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"cPanel OV SSL Certificate"</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">"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo="</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">"image/svg+xml"</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">"USD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product"</span>: <span class="token string">"cPanel OV Certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_category"</span>: <span class="token string">"N/A"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_group"</span>: <span class="token string">"ssl_certificate"</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">"cPanel Store"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">"cPStore"</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">"year"</span></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">"Organization Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"organizationName"</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">"Department Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"organizationalUnitName"</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">"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))"</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">"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"duns_number"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pattern"</span>: <span class="token string">"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"</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">"Street Address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"streetAddress"</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">"City"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"localityName"</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">"State or Province"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"stateOrProvinceName"</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">"Postal Code"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"postalCode"</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">"Country Code"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"countryName"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"country_code"</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">"Representative’s Given (First) Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_forename"</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">"Representative’s Surname (Last Name)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_surname"</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">"Representative’s Email Address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_email_address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"email"</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">"This should be one of the organization’s publicly-listed telephone numbers."</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">"Representative’s Telephone Number"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_telephone"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"tel"</span></div></li></ul><span class="token punctuation">}</span></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">"checkout"</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">"99.00"</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">"990.00"</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">"99.00"</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">"ov"</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">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"billing_type"</span>: <span class="token string">"one-time"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"A domain-validated (DV) SSL certificate signed by COMODO."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"Comodo DV SSL Certificate"</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">"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg=="</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">"image/svg+xml"</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">"USD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product"</span>: <span class="token string">"Comodo DV Certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_category"</span>: <span class="token string">"N/A"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_group"</span>: <span class="token string">"ssl_certificate"</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">"cPanel Store"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">"cPStore"</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">"year"</span></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">"issuance"</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">"99.00"</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">"990.00"</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">"99.00"</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">"dv"</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">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"billing_type"</span>: <span class="token string">"one-time"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"An extended-validated (EV) SSL certificate signed by cPanel."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"cPanel EV SSL Certificate"</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">"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo="</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">"image/svg+xml"</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">"USD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product"</span>: <span class="token string">"cPanel EV Certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_category"</span>: <span class="token string">"N/A"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_group"</span>: <span class="token string">"ssl_certificate"</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">"cPanel Store"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">"cPStore"</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">"year"</span></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">"Organization Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"organizationName"</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">"Department Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"organizationalUnitName"</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">"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))"</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">"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"duns_number"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pattern"</span>: <span class="token string">"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"</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">"Street Address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"streetAddress"</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">"City"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"localityName"</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">"State or Province"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"stateOrProvinceName"</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">"Postal Code"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"postalCode"</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">"Country Code"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"countryName"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"country_code"</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">"Representative’s Given (First) Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_forename"</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">"Representative’s Surname (Last Name)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_surname"</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">"Representative’s Email Address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_email_address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"email"</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">"This should be one of the organization’s publicly-listed telephone numbers."</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">"Representative’s Telephone Number"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"rep_telephone"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"tel"</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">"Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">"Business Category"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"business_category"</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">"b"</span>,</div></li><li><div class="hoverable "><span class="token string">"Incorporated Business (“Private Organization”)"</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">"d"</span>,</div></li><li><div class="hoverable "><span class="token string">"Non-incorporated Business (“Business Entity”)"</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">"c"</span>,</div></li><li><div class="hoverable "><span class="token string">"Government Entity (“Government Entity”)"</span></div></li></ul><span class="token punctuation">]</span></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">"choose_one"</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">"City Where Incorporated (JOI (Jurisdiction of Incorporation))"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"joi_locality_name"</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">"State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"joi_state_or_province_name"</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">"Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"joi_country_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"country_code"</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">"Date of Incorporation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"date_of_incorporation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"date"</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">"Assumed Name (DBA (Doing Business As))"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"assumed_name"</span></div></li></ul><span class="token punctuation">}</span></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">"checkout"</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">"ev"</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="<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>
" 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"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </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="<p>The access token to connect to the provider.</p>
" 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"> <!-- --><<!-- -->json<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->json<!-- --> ></span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">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"}</span></div><div><div html="<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>
" 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="<p>The cPanel Market provider’s name.</p>
" 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"> <!-- --><<!-- -->url<!-- -->><!-- --> </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="<p>The location to which the provider directs the user after the checkout process is complete.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create_shopping_cart"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Market"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"</span><a href="http://www.example.com/checkout">http://www.example.com/checkout</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_id"</span>: <span class="token string">"8765309"</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's login URL<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the login URL for the cPanel Market provider.</p>
" 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="<p>The cPanel Market provider&#39;s name.</p>
" 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_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"> <!-- --><<!-- -->url<!-- -->><!-- --> </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="<p>Where the cPanel Market provider redirects the user&#39;s browser after they log in.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Where the cPanel Market provider redirects the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_login_url"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Market"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"</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&function=login&module=bogoSSL&redirect_uri=https%3A%2F%2Fqaportal.cpanel.net%2Fbogus.cgi&response_type=token</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>This function lists the names of enabled cPanel Market providers.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_providers_list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Market"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"cPanel Store"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"cPStore"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>This function sets the status of an item or items in the cPanel Market pending queue.</p>
" 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&order_item_id-2=12346&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&order_item_id=12346&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="<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>
" 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="<p>The cPanel Market provider&#39;s name.</p>
" 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="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">"confirmed"</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_status_of_pending_queue_items"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Market"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"EntryDoesNotExist"</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">"The order item ID “8675309” does not match any entries in the pending queue."</span></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="<p>This function updates the URL to which a provider sends a user after they check out.</p>
" 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="<p>The access token for the session to the cPanel Market provider.</p>
" 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="<p>The order ID that the cPanel Market provider assigned.</p>
" 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="<p>The cPanel Market provider&#39;s name.</p>
" 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"> <!-- --><<!-- -->url<!-- -->><!-- --> </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="<p>The URL to send the browser after the user checks out.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_url_after_checkout"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Market"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"This is an error."</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function validates a login token to a cPanel Market provider and returns an access token.</p>
" 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="<p>The login token for the cPanel Market provider.</p>
" 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="<p>The name of the cPanel Market provider.</p>
" 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"> <!-- --><<!-- -->url<!-- -->><!-- --> </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="<p>The <code>url_after_login</code> value that you sent to UAPI&#39;s <code>Market::get_login_url</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <code>url_after_login</code> value that you sent to UAPI'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"validate_login_token"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Market"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"8675309"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>Commerce Integration / SSL Certificates</p>
"><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="<p>This function cancels an order and removes the polling for a pending certificate.</p>
" 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="<p>The ID of the ordered item to cancel.</p>
" 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="<p>The cPanel Market provider&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"cancel_pending_ssl_certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Market"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"-----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"</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">"example1.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"example2.com"</span></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">"CertificateNotFound"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_id"</span>: <span class="token string">"1392472"</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">"10427508"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_id"</span>: <span class="token string">"143"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider"</span>: <span class="token string">"cPStore"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"confirmed"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"support_uri"</span>: <span class="token string">"</span><a href="http://support.example.com/">http://support.example.com/</a><span class="token string">"</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">"abcde.com"</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's SSL certificate request status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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"> <!-- -->>= 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="<p>The order ID that the cPanel Market provider assigned.</p>
" 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="<p>The cPanel Market provider&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_certificate_status_details"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Market"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"</span><a href="https://example.com/action">https://example.com/action</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ovCallbackStatus"</span>: <span class="token string">"</span><a href="https://example.com/action">https://example.com/action</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"www.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"AWAITINGBRAND"</span></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">"in-progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"certificateStatus"</span>: <span class="token string">"in-progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"csrStatus"</span>: <span class="token string">"completed"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dcvStatus"</span>: <span class="token string">"completed"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"evClickThroughStatus"</span>: <span class="token string">"in-progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"freeDVUPStatus"</span>: <span class="token string">"not applicable"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organizationValidationStatus"</span>: <span class="token string">"not applicable"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ovCallbackStatus"</span>: <span class="token string">"not applicable"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validationStatus"</span>: <span class="token string">"in-progress"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <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">"Certificate request is still being processed."</span></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's pending SSL certificates<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists all pending SSL certificates from a cPanel Market provider for which the system currently polls.</p>
" 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="<p>The cPanel Market provider&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_pending_ssl_certificates"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Market"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"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-----"</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">"example.com"</span></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">"cPanel"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"business_category"</span>: <span class="token string">"b"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"countryName"</span>: <span class="token string">"US"</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">"1996-01-01"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"duns_number"</span>: <span class="token string">"12-345-6789"</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">"US"</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">"Somewhere"</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">"PA"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"localityName"</span>: <span class="token string">"Houston"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organizationName"</span>: <span class="token string">"WebPros International, LLC"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organizationalUnitName"</span>: <span class="token string">"Team Cobra"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"postalCode"</span>: <span class="token string">"77092"</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">"richard.ang@cpanel.net"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rep_forename"</span>: <span class="token string">"Richard"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rep_surname"</span>: <span class="token string">"Ang"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rep_telephone"</span>: <span class="token string">"713-529-0800"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stateOrProvinceName"</span>: <span class="token string">"TX"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"streetAddress"</span>: <span class="token string">"2500 N. Loop W."</span></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">"CertificateNotFound"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_id"</span>: <span class="token string">"AAE35B28-E57B-11E5-A5DD-B633DD41FB49"</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">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_id"</span>: <span class="token string">"12345"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider"</span>: <span class="token string">"cPStore"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"confirmed"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"support_uri"</span>: <span class="token string">"</span><a href="http://support.example.com/">http://support.example.com/</a><span class="token string">"</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">"example.com"</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's available SSL certificates<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves SSL certificates when they are available from the cPanel Market provider.</p>
" 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="<p>The order item for which to poll.</p>
" 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="<p>The cPanel Market provider&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_ssl_certificate_if_available"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Market"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"-----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-----"</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">"mgs8RgnN0rkRmJz0SAMvjLokoPoXm5LdzEkmKA7IsGmzvU5XTrFInOegFBbWFycToS7FPOevzkH9\\nZp0+QG1xcC/0bWKB1cNeTiYB3Fmv0HGu2ZsA+AYgIhSsZikyD9M6YbHk1IZA3GLNPl8DxX5zG9LQ\\nHiv7Ll2QMJcPmMaJ3xktTY9NuiaPiPmYBljEE094LeqabP3w/kRALDnhR4FcwjsTn7iDJKoxtKju\\nP/DbgV32vhESwWoaKrIYPkSJ/Dav0a/LQqLqD3Jg27WgrW+GaZSbHlHr09UQW/2CIiIK7jbUoLG3\\nANL0fKevyjxrBjCfXQq0umXcZIJPWo4gfukfkQ==\\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ovCallbackStatus"</span>: <span class="token string">"mgs8RgnN0rkRmJz0SAMvjLokoPoXm5LdzEkmKA7IsGmzvU5XTrFInOegFBbWFycToS7FPOevzkH9\\nZp0+QG1xcC/0bWKB1cNeTiYB3Fmv0HGu2ZsA+AYgIhSsZikyD9M6YbHk1IZA3GLNPl8DxX5zG9LQ\\nHiv7Ll2QMJcPmMaJ3xktTY9NuiaPiPmYBljEE094LeqabP3w/kRALDnhR4FcwjsTn7iDJKoxtKju\\nP/DbgV32vhESwWoaKrIYPkSJ/Dav0a/LQqLqD3Jg27WgrW+GaZSbHlHr09UQW/2CIiIK7jbUoLG3\\nANL0fKevyjxrBjCfXQq0umXcZIJPWo4gfukfkQ==\\n"</span></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">"RequiresApproval"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status_message"</span>: <span class="token string">"PRE-SIGN FAILED: CAA: Processing error"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's DCV filename requirements<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the provider&#39;s filename requirements for Domain Control Validation (DCV) checks.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the provider'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="<p>The cPanel Market provider&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_provider_specific_dcv_constraints"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Market"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"A"</span>,</div></li><li><div class="hoverable "><span class="token string">"B"</span>,</div></li><li><div class="hoverable "><span class="token string">"C"</span>,</div></li><li><div class="hoverable "><span class="token string">"D"</span>,</div></li><li><div class="hoverable "><span class="token string">"E"</span>,</div></li><li><div class="hoverable "><span class="token string">"F"</span></div></li></ul><span class="token punctuation">]</span></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">"txt"</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">".well-known/pki-validation"</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">"COMODO DCV"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function submits a request for a certificate order to the cPanel Market provider.</p>
" 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="<p>The access token for the session to the cPanel Market provider.</p>
" 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={"price":6,"product_id":"143","subject_names":[{"dNSName":"example.com"},{"dNSName":"example.org"}],"validity_period":["1, \"year\""],"vhost_names":["example.com"]}</span></div><div><div html="<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>
" 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={"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"}</span></div><div><div html="<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>
" 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="<p>The cPanel Market provider&#39;s name.</p>
" 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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->url<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"request_ssl_certificates"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Market"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"ac90f_639fd_6c236062f0d7a4579a30e01612c4cee0"</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">"</span><a href="http://store.example.com/showmethemoney.cgi">http://store.example.com/showmethemoney.cgi</a><span class="token string">"</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's SSL certificates<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function manually processes the cPanel Market&#39;s SSL certificate request pending queue.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function manually processes the cPanel Market'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"process_ssl_pending_queue"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Market"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"null"</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">"-----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-----"</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">"example.com"</span></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">"CertificateNotFound"</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">"PRE-SIGN FAILED: CAA: Processing error"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_id"</span>: <span class="token string">"19461"</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">"f9d7"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_id"</span>: <span class="token string">"fg2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider"</span>: <span class="token string">"cPStore"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"confirmed"</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">"example.com"</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="<p>cPanel Account / Contact Information</p>
"><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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->email<!-- --> ></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="<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>
" 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<z0ShqdxRP%^</span></div><div><div html="<p>The account’s password.</p>
" 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="<p>Request was successful.</p>
" 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="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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<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">"create"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DynamicDNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Use this function to set an account'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->email<!-- --> ></span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">address=foo@example.com&address=bar@example.com</span></div><div><div html="<p>The account’s new contact email addresses.</p>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->email<!-- --> ></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="<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>
" 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<z0ShqdxRP%^</span></div><div><div html="<p>The account’s password.</p>
" 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="<p>Request was successful.</p>
" 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="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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<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">"set_email_addresses"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ContactInformation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="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="<p>This function checks whether the cPanel account can contact their hosting provider from the cPanel interface.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"is_enabled"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Contactus"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>The Account Enhancement module for UAPI.</p>
"><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's Account Enhancements<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists a cPanel account&#39;s <a href="https://go.cpanel.net/account-enhancements">Account Enhancements</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"AccountEnhancements"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"sample-enhancement-id"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Sample Enhancement"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>This function returns whether a cPanel account has a specific <a href="https://go.cpanel.net/account-enhancements">Account Enhancement</a>.</p>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"AccountEnhancements"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>cPanel Account / Account Information</p>
"><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's cPanel accounts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists all of a reseller&#39;s cPanel accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all of a reseller'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_accounts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Resellers"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"select"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"username"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's configuration settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the user&#39;s account configuration settings.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the user'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&name-2=home&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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user configuration variables to retrieve. If you don't use this parameter, this function returns <strong>all</strong> of the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_user_information"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Variables"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</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">"user2@example.com"</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">"/usr/local/cpanel"</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">"11.94.0.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"database_owner"</span>: <span class="token string">"root"</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">"example.example.com"</span></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">"example.com"</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">"example.com"</span></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">"feature_list"</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">"/home/user"</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">"symlink"</span></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">"192.0.2.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lang"</span>: <span class="token string">"english"</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">"en"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox_format"</span>: <span class="token string">"maildir"</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">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_databases"</span>: <span class="token string">"unlimited"</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">"unlimited"</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">"unlimited"</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">"unlimited"</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">"unlimited"</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">"0"</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">"unlimited"</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">"unlimited"</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">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_subdomains"</span>: <span class="token string">"unlimited"</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">"local"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"example2.com"</span>: <span class="token string">"remote"</span></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">"root"</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">"ext1"</span>,</div></li><li><div class="hoverable "><span class="token string">"ext2"</span>,</div></li><li><div class="hoverable "><span class="token string">"ext3"</span></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">"packagename"</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">"1234567890"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"shell"</span>: <span class="token string">"/bin/bash"</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">"rsa-2048"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"theme"</span>: <span class="token string">"jupiter"</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">"username"</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="<p>cPanel Account / Account Management</p>
"><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="<p>This function updates the cPanel account&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates the cPanel account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to update the cPanel account'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"> <!-- --><<!-- -->password<!-- -->><!-- --> </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="<p>The new password.</p>
" 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"> <!-- --><<!-- -->password<!-- -->><!-- --> </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="<p>The current password.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"change_password"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"UserManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>The AuditLog module for UAPI.</p>
"><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="<p>cPanel Account / Contact Information</p>
"><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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->email<!-- --> ></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="<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>
" 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<z0ShqdxRP%^</span></div><div><div html="<p>The account’s password.</p>
" 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="<p>Request was successful.</p>
" 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="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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<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">"create"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DynamicDNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Use this function to set an account'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->email<!-- --> ></span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">address=foo@example.com&address=bar@example.com</span></div><div><div html="<p>The account’s new contact email addresses.</p>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->email<!-- --> ></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="<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>
" 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<z0ShqdxRP%^</span></div><div><div html="<p>The account’s password.</p>
" 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="<p>Request was successful.</p>
" 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="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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<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">"set_email_addresses"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ContactInformation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="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="<p>This function checks whether the cPanel account can contact their hosting provider from the cPanel interface.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"is_enabled"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Contactus"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>cPanel Account / cPanel Features</p>
"><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's feature access<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks whether a cPanel account has access to
a <a href="https://go.cpanel.net/whmdocsFeatureManager#selectable-features">feature</a>.</p>
" 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="<p>The feature&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The feature'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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's features<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists a cPanel account&#39;s features.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_features"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Features"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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's features' metadata<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the details of a cPanel account&#39;s available feature lists.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the details of a cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_feature_metadata"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Features"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"wordpress_manager"</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">"Wordpress Manager"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>cPanel Account / Disk Quotas</p>
"><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the cPanel account'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'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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_local_quota_info"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Quota"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>This function retrieves the cPanel account&#39;s quota.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_quota_info"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Quota"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>The Personalization module for UAPI.</p>
"><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="<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>
" 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 & 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="<p>List of NVData keys to query the server about.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"coffee"</span>,</div></li><li><div class="hoverable "><span class="token string">"milk"</span></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">"get"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Personalization"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"OK"</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">"hot"</span></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">"OK"</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">"cold"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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 & 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="<p>The NVData keys and values to update.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"hot"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"milk"</span>: <span class="token string">"cold"</span></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">"set"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Personalization"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"OK"</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">"hot"</span></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">"OK"</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">"cold"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>cPanel Account / Resource Usage and Statistics</p>
"><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="<p>This function retrieves resource usage and custom statistics for a cPanel user account.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_usages"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ResourceUsage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"MySQL® Databases"</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">"format_bytes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"mysql_databases"</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">"sql/index.html"</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="<p>This function retrieves a cPanel account&#39;s statistics.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a cPanel account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A pipe-delimited list of the account's statistics.</p>
<details>
<summary>Click for a list of available display parameters.</summary>
<ul>
<li><code>addondomains</code> — Information about the account's addon domains.</li>
<li><code>apacheversion</code> — The server's Apache version.</li>
<li><code>autoresponders</code> — Information about the account's auto-responders.</li>
<li><code>bandwidthusage</code> — Information about the account'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's MySQL® databases currently use.</li>
<li><code>cachedpostgresdiskusage</code> — The amount of cached disk space that the account's PostgreSQL databases use.</li>
<li><code>cpanelversion</code> — The server's cPanel version.</li>
<li><code>dedicatedip</code> — Account websites that use dedicated IP addresses.</li>
<li><code>diskusage</code> — Information the account's disk space usage.</li>
<li><code>emailaccounts</code> — Information about the account's email accounts.</li>
<li><code>emailfilters</code> — Information the account's email filters.</li>
<li><code>emailforwarders</code> — Information about the account's forwarders.</li>
<li><code>fileusage</code> — Information about the account's file usage.</li>
<li><code>ftpaccounts</code> — Information about the account's FTP accounts.</li>
<li><code>hostingpackage</code> — The account's hosting package.</li>
<li><code>hostname</code> — The server's hostname.</li>
<li><code>kernelversion</code> — The operating system'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'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's MySQL databases use.</li>
<li><code>mysqlversion</code> — The server's MySQL version.</li>
<li><code>operatingsystem</code> — The server's operating system.</li>
<li><code>parkeddomains</code> — Information about the account's parked domains (aliases).</li>
<li><code>perlpath</code> — The Perl binary's absolute path.</li>
<li><code>perlversion</code> — The server's Perl version.</li>
<li><code>phpversion</code> — The server'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's PostgreSQL databases use.</li>
<li><code>sendmailpath</code> — The path to the system's sendmail binary.</li>
<li><code>sharedip</code> — Any of the account's websites that use a shared IP address.</li>
<li><code>shorthostname</code> — The short version of your server's hostname.</li>
<li><code>sqldatabases</code> — Information about the all of the account's SQL databases.</li>
<li><code>subdomains</code> — Information about the account's subdomains.</li>
<li><code>theme</code> — The account'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>"</code>) in some
contexts, such as the command line tool.</li>
<li>Some display parameters may be unavailable based on the server'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="<p>The absolute file path to an alternative infinity symbol image.</p>
" 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="<p>A phrase to represent infinity that the locales system can use.</p>
" 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="<p>The type of row.</p>
<ul>
<li><code>odd</code></li>
<li><code>even</code></li>
</ul>
" 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="<p>The minimum level at which to return warnings.</p>
" 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="<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>
" 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'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_stats"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"StatsBar"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"0.00"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_max"</span>: <span class="token string">"1024.00"</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">"0 bytes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature"</span>: <span class="token string">"bandwidth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"bandwidthusage"</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">"Monthly Bandwidth Transfer"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max"</span>: <span class="token string">"1 GB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxed_phrase"</span>: <span class="token string">"You have transferred your maximum allotment of data ([format_bytes,_1]) for this month."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Stats"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"bandwidthusage"</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">"You have transferred [format_bytes,_1] of your [format_bytes,_2] data allotment for this month."</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">"Monthly Bandwidth Transfer"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rowtype"</span>: <span class="token string">"even"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"units"</span>: <span class="token string">"MB"</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">"1.75"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_max"</span>: <span class="token string">"1024.00"</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">"1.75 MB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"diskusage"</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">"Disk Space Usage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"langkey"</span>: <span class="token string">"INDXDiskUsage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max"</span>: <span class="token string">"1 GB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxed_phrase"</span>: <span class="token string">"You are using your maximum storage allotment, [format_bytes,_1]."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Quota"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"diskusage"</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">"You are using [format_bytes,_1] of the [format_bytes,_2] of storage available to you."</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">"Disk Space Usage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rowtype"</span>: <span class="token string">"odd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"units"</span>: <span class="token string">"MB"</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="<p>cPanel Account / Subaccount Management</p>
"><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="<p>This function creates a Subaccount.</p>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An alternate email address for the Subaccount'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"> <!-- --><<!-- -->url<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The URL path to the user'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The Subaccount user&#39;s associated domain that the cPanel account owns.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount user'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"> <!-- --><<!-- -->password<!-- -->><!-- --> </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="<p>The Subaccount&#39;s password.</p>
<p><strong>Note:</strong></p>
<p> Email, FTP, and Web Disk services use this password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount'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="<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>
" 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>'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="<p>The Subaccount user&#39;s first and/or last name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount user'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a reset password email to the Subaccount'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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum amount of disk space, in megabytes (MB), allocated to Subaccount'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'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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount's FTP home directory, relative to the cPanel account'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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount's Web Disk home directory, relative to the cPanel account'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">"rw"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount'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'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to set the directory'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">"sub"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"sub"</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="<p>The type of account.</p>
<ul>
<li><code>sub</code> - A Subaccount.</li>
</ul>
" 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"> <!-- --><<!-- -->username<!-- -->><!-- --> </span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> <!-- --><= 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"UserManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token string">"0.00"</span></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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token string">"0.00"</span></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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</span></div></li></ul><span class="token punctuation">}</span></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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token string">"0.00"</span></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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</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="<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>
" 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'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The Subaccount&#39;s associated domain. The domain <strong>must</strong> be one that the cPanel account owns.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount'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"> <!-- --><= 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"UserManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"string"</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">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"string"</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">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"string"</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">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/account"</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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The Subaccount&#39;s username and domain name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"check_account_conflicts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"UserManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"username@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"info"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/Subaccount"</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">"/username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"username"</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="<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>
" 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's <a href="https://go.cpanel.net/cpaneldocsUserManager"><em>User Manager</em></a> interface (<em>cPanel >> Home >> Preferences >> 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The service account&#39;s associated domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service account'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="<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>
" 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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->username<!-- -->><!-- --> </span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> <!-- --><= 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"dismiss_merge"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"UserManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists a service account&#39;s information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a service account'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="<p>The full username for the system account.</p>
" 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">"email"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ftp"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"webdisk"</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="<p>The type of system account.</p>
<ul>
<li><code>email</code></li>
<li><code>ftp</code></li>
<li><code>webdisk</code></li>
</ul>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"lookup_service_account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"UserManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</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="<p>This function edits a Subaccount.</p>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An alternate email address for the Subaccount'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'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"> <!-- --><<!-- -->url<!-- -->><!-- --> </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="<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>
" 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'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The Subaccount user&#39;s associated domain.</p>
<p>A domain that the cPanel account owns.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount user'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount user'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>'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount user'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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum amount of disk space, in megabytes (MB), that the subaccount'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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount'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'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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount'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'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">"rw"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ro"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"rw"</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="<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>
" 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'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to set the Web Disk directory'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">"sub"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"sub"</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="<p>The type of account.</p>
<ul>
<li><code>sub</code> - A Subaccount.</li>
</ul>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"edit_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"UserManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</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's information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists a single Subaccount&#39;s information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a single Subaccount'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="<p>The Subaccount&#39;s unique identifier.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"lookup_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"UserManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</span></div></li></ul><span class="token punctuation">}</span></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="<p>This function unlinks a service account from a subaccount.</p>
" 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="<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>
" 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's <a href="https://go.cpanel.net/cpaneldocsUserManager"><em>User Manager</em></a> interface (<em>cPanel >> Home >> Preferences >> 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The subaccount&#39;s associated domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The subaccount'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">"email"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ftp"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"webdisk"</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="<p>The service to unlink.</p>
<ul>
<li><code>email</code></li>
<li><code>ftp</code></li>
<li><code>webdisk</code></li>
</ul>
" 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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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="<p>The subaccount&#39;s username.</p>
<p><strong>Note:</strong></p>
<p>This value does <strong>not</strong> include the domain name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The subaccount'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"unlink_service_account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"UserManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The service account&#39;s associated domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service account'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="<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>
" 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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"merge_service_account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"UserManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</span></div></li></ul><span class="token punctuation">}</span></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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</span></div></li></ul><span class="token punctuation">}</span></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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's Subaccounts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the cPanel account&#39;s Subaccounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the cPanel account'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_users"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"UserManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">"</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4"</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">"quota"</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">"Your account is over quota."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"info"</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">"hypothetical"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">"+15551234567"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">"John Doe"</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">"/subaccount"</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">"/bob"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">"rw"</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">"sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>The Team Roles module for UAPI.</p>
"><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="<p>This function gives a list of all team roles and their included features.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_feature_descriptions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"TeamRoles"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"Backup"</span>,</div></li><li><div class="hoverable "><span class="token string">"MySQL® Databases"</span>,</div></li><li><div class="hoverable "><span class="token string">"PHP"</span></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">"database"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">"Database"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>The Team User module for UAPI.</p>
"><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="<p>This function stops a team user from expiring.</p>
" 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="<p>The username of the team user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"expire_team_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function reinstates a team user by removing any suspended or expired statuses. The reason field is also cleared.</p>
" 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="<p>The username of the team user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"reinstate_team_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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'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="<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>
" 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 'days'.</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="<p>The reason for expiration.</p>
" 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="<p>The username of the team user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_expire"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The role or roles to add to the team user. Current roles include admin, database, email, web.</p>
" 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="<p>The username of the team user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_roles"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function enables a team user to reset the password by sending a password reset request link.</p>
" 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="<p>The username of the team user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"password_reset_request"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function sets or changes primary and secondary email addresses.</p>
" 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="<p>The primary contact email address to set for the team user.</p>
" 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="<p>The secondary contact email address to set for the team user.</p>
" 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="<p>The username of the team user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_contact_email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function replaces the current password with a new one.</p>
" 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="<p>The password to set for the team user.</p>
" 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="<p>The username of the team user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_password"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function removes roles from a team user.</p>
" 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="<p>The role or roles to remove from the team user.</p>
" 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="<p>The username of the team user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"remove_roles"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<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>
" 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="<p>The contact email for the new team user.</p>
" 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="<p>The secondary email for the new team user.</p>
" 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="<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>
" 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 'days'.</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="<p>The reason for expiration.</p>
" 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="<p>Notes about the new team user. This field should not contain private information. Maximum of 100 characters.</p>
" 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="<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>
" 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="<p>A comma-separated list of roles assigned to the new team user. Current roles include admin, database, email, web.</p>
" 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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum amount of disk space, in megabytes (MB), allocated to the team user'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'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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The team user's FTP home directory, relative to the cPanel account'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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The team user's Web Disk home directory, relative to the cPanel account'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">"rw"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The team user'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'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to set the directory'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="<p>The username of the team user. Follows cPanel standards.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_team_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The format in which the team data is listed.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"team_user@example.com"</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">"team user 1 year"</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">"en"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notes"</span>: <span class="token string">"This is a note about team user."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"password"</span>: <span class="token string">"encryptedpassword"</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">"email,web"</span></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">"team_user_backup@example.com"</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">"500*2**20"</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">"rw"</span></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">"team user is on vacation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"teamuser"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>This function immediately suspends a team user.</p>
" 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="<p>The reason for suspension.</p>
" 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="<p>The username of the team user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"suspend_team_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function modifies a team user.</p>
" 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="<p>The role or roles to add to the team user.</p>
" 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="<p>The primary contact email address to set for the team user.</p>
" 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="<p>The secondary contact email address to set for the team user.</p>
" 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="<p>The reason for expiration.</p>
" 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="<p>Notes about the new team user. This field should not contain private information.</p>
" 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="<p>The password to set for the team user.</p>
" 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="<p>The role or roles to remove from the team user.</p>
" 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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum amount of disk space, in megabytes (MB), allocated to the team user'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'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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The team user's FTP home directory, relative to the cPanel account'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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The team user's Web Disk home directory, relative to the cPanel account'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">"rw"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The team user'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'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to set the directory'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="<p>The epoch time the team user account expires on or the offset in days.</p>
" 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="<p>The role or roles to set for the team user.</p>
" 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="<p>The username of the team user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"edit_team_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function replaces the current notes field with new text.</p>
" 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="<p>The content of the notes field.</p>
" 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="<p>The username of the team user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_notes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function sets locale for a team user.</p>
" 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="<p>The new locale for the team user.</p>
" 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="<p>The username of the team user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_locale"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function returns the current and maximum number of team users with roles.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_team_users_with_roles_count"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<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>
" 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="<p>The role or roles to set for the team user. Current roles include admin, database, email, web.</p>
" 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="<p>The username of the team user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_roles"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function removes a team user.</p>
" 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="<p>The username of the team user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"remove_team_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>The Backup module for UAPI.</p>
"><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="<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>
" 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="<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>
" 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'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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">"include"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"include"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"skip"</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="<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>
" 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="<p>The remote server&#39;s hostname or IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server'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="<p>The remote server account&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server account'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="<p>The port to use during the transfer.</p>
" 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="<p>The remote server account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"fullbackup_to_scp_with_password"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Backup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"2857"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<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>
" 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's default login directory.</li>
<li>Enter the directory relative to the FTP user'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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">"include"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"include"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"skip"</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="<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>
" 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="<p>The remote server&#39;s hostname or IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server'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="<p>The remote server account&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server account'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="<p>The port number to use during the transfer.</p>
" 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="<p>The remote server account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server account'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">"active"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"active"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"passive"</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"fullbackup_to_ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Backup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"2857"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a full backup to the user'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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">"include"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"include"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"skip"</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"fullbackup_to_homedir"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Backup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"2857"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<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>
" 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'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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">"include"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"include"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"skip"</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="<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>
" 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="<p>The remote server&#39;s hostname or IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH key'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"> <!-- -->>= 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="<p>The SSH key&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH key'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="<p>The port to use during the transfer.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"fullbackup_to_scp_with_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Backup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"2857"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function lists the account&#39;s backup files.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_backups"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Backup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"2014-12-02"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>cPanel Account Backups / File Restoration</p>
"><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all of the backup files and directories in the user'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A path to a subdirectory within the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"directory_listing"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Restore"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"public_html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"onDiskType"</span>: <span class="token string">"file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"file"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a reseller'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_users"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Restore"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"username"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all of an item'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="<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>
" 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's value.</li>
<li><code>0</code> — Do <strong>not</strong> show the <code>exists</code> return'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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A file, directory, or symlink in the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"query_file_info"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Restore"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"2020-07-01"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backupID"</span>: <span class="token string">"weekly/2017-07-01"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backupType"</span>: <span class="token string">"compressed"</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">"/public_html/index.php"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"file"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores a file or directory from a backup to the file or directory'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The backup'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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute file or directory'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"restore_file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Restore"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores a database'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="<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>
" 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"> <!-- -->>= 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="<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>
" 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="<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>
" 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="<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>
" 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'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'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"> <!-- --><<!-- -->binary<!-- -->><!-- --> </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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"restore_databases"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Backup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"2019-08-13T15:10:07Z.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log_path"</span>: <span class="token string">"/home/cptest/logs/restoredb/2019-08-13T15:10:07Z.1.log"</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">"The system successfully restored the database 'user_db1' from the backup file 'user_db1.sql.gz'"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores an account'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'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="<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>
" 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"> <!-- -->>= 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="<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>
" 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="<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>
" 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="<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>
" 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't already exist on the server.</li>
<li>You can'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"> <!-- --><<!-- -->binary<!-- -->><!-- --> </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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"restore_email_forwarders"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Backup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"2019-08-13T15:10:07Z.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log_path"</span>: <span class="token string">"/home/cpuser/.cpanel/logs/restore-email-forwarders/2019-09-11T18:30:49Z.1.log"</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">"The system successfully restored the email forwarders from the 'aliases-example.com.gz' backup."</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores an account'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="<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>
" 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"> <!-- -->>= 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="<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>
" 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="<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>
" 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="<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>
" 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't already exist on the server.</li>
<li>You can'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'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"> <!-- --><<!-- -->binary<!-- -->><!-- --> </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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"restore_email_filters"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Backup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"2019-08-13T15:10:07Z.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log_path"</span>: <span class="token string">"/home/cpuser/.cpanel/logs/restore-email-filters/2019-09-11T18:30:49Z.1.log"</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">"The system successfully restored the email filters from the 'filter-info.user.yaml.gz' backup."</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores an account'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'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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The directory to which to restore the file. The default is the user&#39;s <code>home</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory to which to restore the file. The default is the user'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"> <!-- -->>= 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="<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>
" 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="<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>
" 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="<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>
" 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't already exist on the server.</li>
<li>You can'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"> <!-- --><<!-- -->binary<!-- -->><!-- --> </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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"restore_files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Backup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"2019-08-13T15:10:07Z.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log_path"</span>: <span class="token string">"/home/cptest/.cpanel/logs/restorefiles/2019-08-13T15:10:07Z.1.log"</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">"The system successfully restored the directory /home/cpuser/point2 from the backup file backup-cpuser.tld-9-10-2019_1.tar.gz"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>cPanel Theme Management / Application Information</p>
"><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' info from dynamicui.conf<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves an application&#39;s information from a specific theme&#39;s <code>dynamicui.conf</code> file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an application's information from a specific theme'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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_applications"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Branding"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">""</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">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature"</span>: <span class="token string">"addondomains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">"addon_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"height"</span>: <span class="token string">"48"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"if"</span>: <span class="token string">"$HASROLE{'WebServer'}"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"imgtype"</span>: <span class="token string">"icon"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"implements"</span>: <span class="token string">"Domains_AddonDomains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemdesc"</span>: <span class="token string">"Addon Domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemorder"</span>: <span class="token string">"3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"addon_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"onclick"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"plainitemdesc"</span>: <span class="token string">"Addon Domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchtext"</span>: <span class="token string">"Domains Addon domain Addon Domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subtype"</span>: <span class="token string">"img"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"addon/index.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"width"</span>: <span class="token string">"48"</span></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">""</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">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature"</span>: <span class="token string">"ftpaccts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">"anonymous_ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"height"</span>: <span class="token string">"48"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"if"</span>: <span class="token string">"$SERVICEPROVIDED{'ftp'} && $hasanonftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"imgtype"</span>: <span class="token string">"icon"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemdesc"</span>: <span class="token string">"Anonymous FTP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemorder"</span>: <span class="token string">"8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"anonymous_ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"onclick"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"plainitemdesc"</span>: <span class="token string">"Anonymous FTP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchtext"</span>: <span class="token string">"Anonymous FTP anonymousftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subtype"</span>: <span class="token string">"img"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"touch"</span>: <span class="token string">"ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"ftp/anonymous.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"width"</span>: <span class="token string">"48"</span></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">""</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">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature"</span>: <span class="token string">"ftpaccts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">"ftp_accounts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"height"</span>: <span class="token string">"48"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"if"</span>: <span class="token string">"$SERVICEPROVIDED{'ftp'}"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"imgtype"</span>: <span class="token string">"icon"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemdesc"</span>: <span class="token string">"FTP Accounts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemorder"</span>: <span class="token string">"6"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"ftp_accounts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"onclick"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"plainitemdesc"</span>: <span class="token string">"FTP Accounts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchtext"</span>: <span class="token string">"FTP Accounts ftp create"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subtype"</span>: <span class="token string">"img"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"touch"</span>: <span class="token string">"ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"ftp/accounts.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"width"</span>: <span class="token string">"48"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's cPanel application details<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves information about the groups and applications in the authenticated user&#39;s cPanel interface.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves information about the groups and applications in the authenticated user'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_available_applications"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Branding"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"files"</span>,</div></li><li><div class="hoverable "><span class="token string">"databases"</span>,</div></li><li><div class="hoverable "><span class="token string">"domains"</span>,</div></li><li><div class="hoverable "><span class="token string">"email"</span>,</div></li><li><div class="hoverable "><span class="token string">"metrics"</span>,</div></li><li><div class="hoverable "><span class="token string">"security"</span>,</div></li><li><div class="hoverable "><span class="token string">"software"</span>,</div></li><li><div class="hoverable "><span class="token string">"advanced"</span>,</div></li><li><div class="hoverable "><span class="token string">"preferences"</span>,</div></li><li><div class="hoverable "><span class="token string">"pref"</span></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">"Files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"files"</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">"target=\"file_manager\""</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">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature"</span>: <span class="token string">"filemanager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">"file_manager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"height"</span>: <span class="token string">"48"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"if"</span>: <span class="token string">"$HASROLE{'FileStorage'}"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"imgtype"</span>: <span class="token string">"icon"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"implements"</span>: <span class="token string">"FileManager_Home"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemdesc"</span>: <span class="token string">"File Manager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemorder"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"file_manager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"onclick"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"plainitemdesc"</span>: <span class="token string">"File Manager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchtext"</span>: <span class="token string">"File Manager file-manager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subtype"</span>: <span class="token string">"img"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">"file_manager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"filemanager/index.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"width"</span>: <span class="token string">"48"</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">"api_tokens"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Backups_Home"</span>: <span class="token string">"backup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Calendar_Configure"</span>: <span class="token string">"calendar_and_contacts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ContactInfo_Change"</span>: <span class="token string">"contact_information"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Cron_Home"</span>: <span class="token string">"cron_jobs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Database_MySQL"</span>: <span class="token string">"mysql_databases"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Database_phpMyAdmin"</span>: <span class="token string">"php_my_admin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Domains_AddonDomains"</span>: <span class="token string">"addon_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Domains_SubDomains"</span>: <span class="token string">"subdomains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_AccountLevelFiltering"</span>: <span class="token string">"global_email_filters"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_Accounts"</span>: <span class="token string">"email_accounts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_Authentication"</span>: <span class="token string">"email_deliverability"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_AutoResponders"</span>: <span class="token string">"autoresponders"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_BoxTrapper"</span>: <span class="token string">"boxtrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_DefaultAddress"</span>: <span class="token string">"default_address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_DeliveryReport"</span>: <span class="token string">"track_delivery"</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">"email_disk_usage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_Forwarders"</span>: <span class="token string">"forwarders"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_MailingLists"</span>: <span class="token string">"mailing_lists"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_Routing"</span>: <span class="token string">"email_routing"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_SpamFilter"</span>: <span class="token string">"apache_spam_assassin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_UserLevelFiltering"</span>: <span class="token string">"email_filters"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FileManager_Home"</span>: <span class="token string">"file_manager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Locale_Change"</span>: <span class="token string">"change_language"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Password_Change"</span>: <span class="token string">"change_password"</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">"ssl_tls"</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">"tls_status"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Site_Software"</span>: <span class="token string">"site_software"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Stats_AWStats"</span>: <span class="token string">"awstats"</span></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's info from sitemap.json<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves an application&#39;s information from a specific
theme&#39;s <code>sitemap.json</code> file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an application's information from a specific
theme'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="<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>
" 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'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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_information_for_applications"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Branding"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"blockers"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"if"</span>: <span class="token string">"!$isarchiveuser"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Email Filters"</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">"email_filters"</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">"Email_UserLevelFiltering"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"email_filters"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Email Filters"</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">"email"</span>,</div></li><li><div class="hoverable "><span class="token string">"filter"</span>,</div></li><li><div class="hoverable "><span class="token string">"filters"</span></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">"item"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"mail/filters/userfilters.html"</span></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">"blockers"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"if"</span>: <span class="token string">"!$isarchiveuser"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Email Filters"</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">"email_filters"</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">"Email_UserLevelFiltering"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"email_filters"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Email Filters"</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">"email"</span>,</div></li><li><div class="hoverable "><span class="token string">"filter"</span>,</div></li><li><div class="hoverable "><span class="token string">"filters"</span></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">"item"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"mail/filters/userfilters.html"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's info from dynamicui.conf<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves an application&#39;s information from the <code>dynamicui.conf</code> file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an application'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application's feature name. This value <strong>must</strong> match a feature'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_application_information"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Branding"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"boxtrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">"boxtrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"mail"</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">"$hasboxtrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"imgtype"</span>: <span class="token string">"icon"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemdesc"</span>: <span class="token string">"BoxTrapper"</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">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchtext"</span>: <span class="token string">"boxtrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subtype"</span>: <span class="token string">"img"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"mail/boxtrapper.html"</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="<p>cPanel Theme Management / Brand Management</p>
"><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="<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>
" 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="<p>The title of the page to wrap in the theme&#39;s headers and footers.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The title of the page to wrap in the theme'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_dom"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Chrome"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"\n<!-- The Footer HTML of the user's assigned theme -->\n</html>\n\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"header"</span>: <span class="token string">"\n\n<!DOCTYPE html>\n\n<html lang=\"en\" dir=\"ltr\">\n<!-- The Header HTML of the user's assigned theme -->"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>cPanel Theme Management / Browser Cache Management</p>
"><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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"update"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CacheBuster"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<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>
" 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?<CacheBusterID></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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"read"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CacheBuster"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>cPanel Theme Management / Language</p>
"><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="<p>This function sets the account&#39;s locale.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the account'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="<p>The locale&#39;s abbreviated name according to UAPI&#39;s <code>Locale::list_locales</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The locale's abbreviated name according to UAPI'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_locale"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Locale"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function lists an account&#39;s available interface languages.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_locales"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Locale"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"ltr"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local_name"</span>: <span class="token string">"Deutsch"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">"de"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"German"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>This function retrieves information about the user&#39;s current locale setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves information about the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_attributes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Locale"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"ltr"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"encoding"</span>: <span class="token string">"utf-8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">"en"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"English"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>cPanel Theme Management / Theme Settings</p>
"><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="<p>This function is deprecated and does not return useful output.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_theme_base"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Themes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"jupiter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>The theme name.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"update"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Themes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to list the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Themes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"jupiter"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>Directory Management / Directory Indexes</p>
"><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="<p>This function returns the directory indexing settings for a directory on the cPanel account and its subdirectories.</p>
" 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="<p>The directory for which to check the indexing type.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_indexing"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DirectoryIndexes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"disabled"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function returns the <a href="https://go.cpanel.net/cpaneldocsIndexes">directory indexing</a> settings of the subdirectories in a directory.</p>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The absolute path of the directory for which to return indexing information.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_directories"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DirectoryIndexes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/example/example.com/cgi-bin"</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">"inherit"</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">"/home/example/example.com"</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">"inherit"</span></div></li></ul><span class="token punctuation">}</span></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">"/home/example"</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">"inherit"</span></div></li></ul><span class="token punctuation">}</span></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">"/home/example"</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">"inherit"</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="<p>This function configures the <a href="https://go.cpanel.net/cpaneldocsIndexes">directory indexing</a> settings for a directory on the cPanel account.</p>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The directory for which to manage directory indexing.</p>
" 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">"standard"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"disabled"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"inherit"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"fancy"</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="<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>
" 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't use directory indexing.</li>
<li><code>inherit</code> — The directory uses the system'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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_indexing"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DirectoryIndexes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"disabled"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>Directory Management / Directory Privacy</p>
"><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="<p>This function confirms whether a directory uses password protection.</p>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The absolute directory path on the cPanel account to check for password protection.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"is_directory_protected"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DirectoryPrivacy"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"Protected 'example.com'"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_type"</span>: <span class="token string">"Basic"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd_file"</span>: <span class="token string">"/home/example/.htpasswds/example.com/passwd"</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="<p>This function returns the users who can access a password-protected directory on the cPanel account.</p>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The password-protected directory for which to return authorized users.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_users"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DirectoryPrivacy"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example1"</span>,</div></li><li><div class="hoverable "><span class="token string">"example2"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>This function returns the privacy status of the subdirectories in a directory.</p>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The directory path for which to return the subdirectories&#39; privacy information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory path for which to return the subdirectories' 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_directories"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DirectoryPrivacy"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/example/example.com/cgi-bin"</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">"Protected 'example.com'"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_type"</span>: <span class="token string">"Basic"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd_file"</span>: <span class="token string">"/home/example/.htpasswds/example.com/passwd"</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">"/home/example/example.com"</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">"protected"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_type"</span>: <span class="token string">"Basic"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd_file"</span>: <span class="token string">"/home/example/.htpasswds/example.com/passwd"</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">"/home/example"</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">"protected"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_type"</span>: <span class="token string">"Basic"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd_file"</span>: <span class="token string">"/home/example/.htpasswds/example.com/passwd"</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">"/home/example"</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">"protected"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_type"</span>: <span class="token string">"Basic"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd_file"</span>: <span class="token string">"/home/example/.htpasswds/example.com/passwd"</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="<p>This function enables or disables password protection for a directory on the cPanel account.</p>
" 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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The absolute or relative directory path for which to enable or disable password protection.</p>
" 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="<p>Whether to enable password protection for the directory.</p>
<ul>
<li><code>1</code> - Enable.</li>
<li><code>0</code> - Disable.</li>
</ul>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"configure_directory_protection"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DirectoryPrivacy"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"protectandserve"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_type"</span>: <span class="token string">"Basic"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd_file"</span>: <span class="token string">"/home/example/.htpasswds/example.com/passwd"</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="<p>This function deletes a user who can access a protected directory on the cPanel account.</p>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The absolute directory path on the cPanel account from which to remove a user.</p>
" 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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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="<p>The username to remove from the directory.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DirectoryPrivacy"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function adds a user who can access a protected directory on the cPanel account.</p>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The directory to add users to.</p>
" 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="<p>The password for the user.</p>
" 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="<p>The username of the user who can access the directory.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DirectoryPrivacy"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>Directory Management / Directory Protection</p>
"><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="<p>This function returns the
<a href="https://go.cpanel.net/cpaneldocsLeechProtection">leech protection</a>
settings of the subdirectories in a directory.</p>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The absolute or relative file path in the user&#39;s <code>home</code> directory for which to return leech protection information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute or relative file path in the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_directories"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DirectoryProtection"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/example/example.com/cgi-bin"</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">"/home/example/example.com"</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">"/home/example"</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">"/home/example"</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="<p>The DNS module for UAPI.</p>
"><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="<p>This function indicates whether the account&#39;s domains resolve exclusively to this server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function indicates whether the account'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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-1=example1.com&domain-2=example2.com</span> -<!-- --> <!-- -->Multiple domains</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com&domain=example1.com&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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"ensure_domains_reside_only_locally"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"The domain resolves to Mars. Beep beep beep."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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 & resolver<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"is_alias_available"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"8.8.8.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">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's DNS information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns DNS zone information about a domain.</p>
" 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="<p>A fully qualified domain name.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"lookup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com has address 93.184.216.34"</span>,</div></li><li><div class="hoverable "><span class="token string">"example.com has IPv6 address 2606:2800:220:1:248:1893:25c8:1946"</span>,</div></li><li><div class="hoverable "><span class="token string">"example.com mail is handled by 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>: <button class="collapser" aria-label="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="<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>
" 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'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="<p>The name of one of the user’s DNS zones.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"parse_zone"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"record"</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">"dGV4YXMuY29tLg=="</span></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">"dGV4YXMuY29tLg=="</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"record_type"</span>: <span class="token string">"MX"</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="<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>
" 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"> <!-- --><<!-- -->json<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->json<!-- --> ></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='{"dname":"example", "ttl":14400, "record_type":"A", "data":["11.22.33.44"]}'</span> -<!-- --> <!-- -->An A record.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">add='{"dname":"example", "ttl":14400, "record_type":"TXT", "data":["string1", "string2"]}'</span> -<!-- --> <!-- -->A TXT record.</li></ul><div><div html="<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>
" 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"> <!-- --><<!-- -->json<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->json<!-- --> ></span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">edit='{"line_index": 9, "dname":"example", "ttl":14400, "record_type":"TXT", "data":["string1", "string2"]}'</span></div><div><div html="<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>
" 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"> <!-- -->>= 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="<p>The line indexes of records to remove from the zone.</p>
" 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"> <!-- -->>= 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="<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>
" 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="<p>The name of one of the user’s DNS zones.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"mass_edit_zone"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>This function replaces a domain&#39;s IPv4 address in the DNS zone
file with the specified destination IPv4 address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function replaces a domain'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"> <!-- --><<!-- -->ipv4<!-- -->><!-- --> </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="<p>The IPv4 address to use as the replacement in the zone files.</p>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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"> <!-- --><<!-- -->ipv4<!-- -->><!-- --> </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="<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>
" 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"> <!-- --><<!-- -->ipv4<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"swap_ip_in_zones"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"record_name"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"record_type"</span>: <span class="token string">"A"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"old_value"</span>: <span class="token string">"192.0.2.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"new_value"</span>: <span class="token string">"192.0.2.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/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="<p>This function checks whether the local server is authoritative for the domain&#39;s DNS records.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the local server is authoritative for the domain'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain to check whether the local server is authoritative for the domain'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"has_local_authority"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</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">"ns1.example.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"ns2.example.com"</span></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">"example.com"</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">"example2.com"</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">"example3.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">"(XID 3z756a) DNS query (example3.com/SOA) timeout!"</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">"example3.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>DNS / DNS Information</p>
"><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="<p>This function indicates whether the account&#39;s domains resolve exclusively to this server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function indicates whether the account'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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-1=example1.com&domain-2=example2.com</span> -<!-- --> <!-- -->Multiple domains</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com&domain=example1.com&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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"ensure_domains_reside_only_locally"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"The domain resolves to Mars. Beep beep beep."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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 & resolver<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"is_alias_available"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"8.8.8.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">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's DNS information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns DNS zone information about a domain.</p>
" 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="<p>A fully qualified domain name.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"lookup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com has address 93.184.216.34"</span>,</div></li><li><div class="hoverable "><span class="token string">"example.com has IPv6 address 2606:2800:220:1:248:1893:25c8:1946"</span>,</div></li><li><div class="hoverable "><span class="token string">"example.com mail is handled by 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>: <button class="collapser" aria-label="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="<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>
" 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'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="<p>The name of one of the user’s DNS zones.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"parse_zone"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"record"</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">"dGV4YXMuY29tLg=="</span></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">"dGV4YXMuY29tLg=="</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"record_type"</span>: <span class="token string">"MX"</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="<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>
" 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"> <!-- --><<!-- -->json<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->json<!-- --> ></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='{"dname":"example", "ttl":14400, "record_type":"A", "data":["11.22.33.44"]}'</span> -<!-- --> <!-- -->An A record.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">add='{"dname":"example", "ttl":14400, "record_type":"TXT", "data":["string1", "string2"]}'</span> -<!-- --> <!-- -->A TXT record.</li></ul><div><div html="<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>
" 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"> <!-- --><<!-- -->json<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->json<!-- --> ></span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">edit='{"line_index": 9, "dname":"example", "ttl":14400, "record_type":"TXT", "data":["string1", "string2"]}'</span></div><div><div html="<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>
" 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"> <!-- -->>= 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="<p>The line indexes of records to remove from the zone.</p>
" 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"> <!-- -->>= 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="<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>
" 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="<p>The name of one of the user’s DNS zones.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"mass_edit_zone"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>This function checks whether the local server is authoritative for the domain&#39;s DNS records.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the local server is authoritative for the domain'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain to check whether the local server is authoritative for the domain'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"has_local_authority"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</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">"ns1.example.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"ns2.example.com"</span></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">"example.com"</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">"example2.com"</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">"example3.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">"(XID 3z756a) DNS query (example3.com/SOA) timeout!"</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">"example3.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>DNS / DNS Security</p>
"><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="<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>
" 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="<p>The domain on which to disable NSEC3 semantics and use NSEC semantics.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"unset_nsec3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNSSEC"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The security key&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key'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"> <!-- -->>= 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="<p>The security key&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"export_zone_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNSSEC"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_content"</span>: <span class="token string">"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"</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">"KSK"</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="<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>
" 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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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&domain-1=example1.com&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="<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>
" 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">"classic"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"simple"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"classic"</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="<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>
" 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="<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>
" 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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->hex<!-- -->><!-- --> </span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> <!-- --><= 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="<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>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"enable_dnssec"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNSSEC"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsec_version"</span>: <span class="token string">"NSEC3"</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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The security key&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key'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="<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>
" 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'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">"ksk"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"zsk"</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="<p>The security key&#39;s type.</p>
<ul>
<li><code>ksk</code></li>
<li><code>zsk</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"import_zone_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNSSEC"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</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">"1"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function exports a domain'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain from which to fetch the DNSKEY record value.</p>
" 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"> <!-- -->>= 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="<p>The DNSSEC record&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The DNSSEC record'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"export_zone_dnskey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNSSEC"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"AwEAAch8SGW4vE6PjFWA9rbUm0AfTq+gJ0HC/nLu+2axdWHBIStt9lsOzKDorAr4vlmhlJzEzA62s96xp6mZ7XHUyWnkFwLs8obo6upL2in4h1ToOxzVl3lTs8O+kWtDq5/h1nwFlPDs9zpLJhlkTCtx2OTGbvimEYeqwPolUuSQR/Yb"</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's DS records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function fetches a domain'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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&domain-1=example1.com&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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"fetch_ds_records"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNSSEC"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"RSA/SHA-256"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"algo_num"</span>: <span class="token string">"8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"algo_tag"</span>: <span class="token string">"RSASHA256"</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">"1590002705"</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">"ZSK"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"privatekey"</span>: <span class="token string">"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=="</span></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">"SHA-1"</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">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsec3_iterations"</span>: <span class="token string">"3"</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">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsec3_salt"</span>: <span class="token string">"fa1ac2c1rd7fbab4"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsec_version"</span>: <span class="token string">"NSEC3"</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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The security key&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key'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"> <!-- -->>= 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="<p>The security key&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"remove_zone_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNSSEC"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token string">"12"</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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The security key&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key'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"> <!-- -->>= 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="<p>The security key&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"deactivate_zone_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNSSEC"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">"Error: Invalid key_id or domain specified: No such key present for domain."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token string">"1"</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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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&domain-1=example1.com&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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_dnssec"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNSSEC"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<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>
" 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="<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>
" 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="<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>
" 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 'ECDSA Curve P-256 with SHA-256' 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain on which to enable DNSSEC.</p>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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">"ksk"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"zsk"</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="<p>The type of key to add.</p>
<ul>
<li><code>ksk</code></li>
<li><code>zsk</code></li>
</ul>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_zone_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNSSEC"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">"Error: Invalid key_id or domain specified: No such key present for domain."</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">"1"</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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain on which to enable NSEC3 semantics.</p>
" 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="<p>The number of times that the system re-executes the first resource record hash operation.</p>
" 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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->hex<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_nsec3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNSSEC"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The security key&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key'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"> <!-- -->>= 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="<p>The security key&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"activate_zone_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DNSSEC"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token string">"1"</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="<p>DNS / Dynamic DNS</p>
"><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="<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>
" 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="<p>A human-readable string that describes the domain.</p>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The fully-qualified domain name to create as a DDNS domain.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DynamicDNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"ggiugyxxjwnkmqtwysgmvrurplmafxpq"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DynamicDNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"My home network"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"home.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"gziugyxxjwnamqtwysgmvrurplmafxpj"</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="<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>
" 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="<p>The DDNS domain’s ID.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DynamicDNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<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>
" 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="<p>The DDNS domain’s ID.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"recreate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DynamicDNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"ggiugyxxjwnkmqtwysgmvrurplmafxpq"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>A human-readable string that describes the domain.</p>
" 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="<p>The DDNS domain’s ID.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DynamicDNS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="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="<p>DNS / Email DNS Settings</p>
"><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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The new mail exchanger&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new mail exchanger'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The new mail exchanger&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new mail exchanger'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"> <!-- -->>= 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new mail exchanger'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_mx"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"auto"</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">"auto"</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">"Auto Detect of MX configuration not possible due to non-resolving MX entries. Defaulting to last known setting: local."</span></div></li></ul><span class="token punctuation">]</span></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">"Added entry:\\nBind reloading on example using rndc zone: [example.com]\\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"Added entry:\\nBind reloading on example using rndc zone: [example.com]\\n"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The mail exchanger&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The mail exchanger&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The mail exchanger&#39;s current name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger'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"> <!-- -->>= 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger'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"> <!-- -->>= 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"change_mx"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"auto"</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">"auto"</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">"Auto Detect of MX configuration not possible due to non-resolving MX entries. Defaulting to last known setting: local."</span></div></li></ul><span class="token punctuation">]</span></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">"Replacing existing entry on line matched old entry and old priority: 51:\\nBind reloading on example using rndc zone: [example.com]"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"Replacing existing entry on line matched old entry and old priority: 51:\\nBind reloading on example using rndc zone: [example.com]"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The mail exchanger&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger'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="<p>The mail exchanger&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger'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"> <!-- -->>= 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_mx"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"auto"</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">"auto"</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">"Auto Detect of MX configuration not possible due to non-resolving MX entries. Defaulting to last known setting: local."</span></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">"Removed entry: example.com. IN MX 15 mail.example.com\nBind reloading on example using rndc zone: [example.com]"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"Removed entry: example.com. IN MX 15 mail.example.com\nBind reloading on example using rndc zone: [example.com]"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function applies a DMARC record to the specified domain(s)</p>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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' 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' DMARC records.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> -<!-- --> <!-- -->Enable a single domain's DMARC records.</li></ul><div><div html="<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>
" 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'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"apply_dmarc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"EmailAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">"[ADD:TXT@_dmarc.example.com:v=DMARC1; p=reject;]"</span><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="<p>This function removes the DMARC record for domains.</p>
" 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&domain=example2.com&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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"remove_dmarc"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"EmailAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">"[REMOVE:TXT@_dmarc.example.com:v=DMARC1; p=reject;]"</span><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' DMARC records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks the validity of the current DMARC record for one or more domains.</p>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"validate_current_dmarcs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"EmailAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">"(XID 4krw35) DNS returned SERVFAIL (code 2)\nin response to the system's query for _dmarc.example.com\nTXT records."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"record"</span>: <span class="token string">"v=DMARC1; p=none;"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">"VALID"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subdomain"</span>: <span class="token string">"_dmarc.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suggested"</span>: <span class="token string">"v=DMARC1; p=none;"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_mxs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"local"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</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">"example.com"</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">"mx.example.com"</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">"odd"</span></div></li></ul><span class="token punctuation">}</span></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">"mx.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mxcheck"</span>: <span class="token string">"auto"</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">"Fetched MX List"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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' DKIM records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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' 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' DKIM records.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> -<!-- --> <!-- -->Enable a single domain's DKIM records.</li></ul><div><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"enable_dkim"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"EmailAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">"[no changes needed]"</span><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' DKIM private keys<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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=example2.com&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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"ensure_dkim_keys_exist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"EmailAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">"created new key"</span><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' DKIM private keys<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a domain'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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=example2.com&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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"fetch_dkim_private_keys"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"EmailAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pem"</span>: <span class="token string">"-----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"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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' DKIM record keys<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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's records.</li>
<li>If the local DNS server is authoritative for the domain's DNS records, use the UAPI <code>EmailAuth::enable_dkim</code> function to update the local DNS server'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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&domain=example2.com&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="<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>
" 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"> <!-- --><<!-- -->pem-private-key<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"install_dkim_private_keys"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"EmailAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">"[ADD:TXT@default._domainkey:v=DKIM1; k=rsa; p=AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw;]"</span><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' SPF records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function installs a Sender Policy Framework (SPF) record for a domain on the DNS server.</p>
" 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&domain=example2.com&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="<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>
" 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="v=spf1 ip4:10.0.0.1 %2Ba %2Bmx %2Bip4:10.0.0.2 %2Bip4:10.0.0.3 -all"</span></div><div><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"install_spf_records"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"EmailAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">"[ADD:TXT@example.com.:v=spf1 ip4:10.0.0.1 %2Ba %2Bmx %2Bip4:10.0.0.2 %2Bip4:10.0.0.3 -all]"</span><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' DKIM records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves and checks the DomainKeys Identified Mail
(DKIM) records for one or more domains.</p>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain for which to check the DKIM records.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"validate_current_dkims"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"EmailAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"default._domainkey.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">"(XID 4krw35) DNS returned SERVFAIL (code 2)\nin response to the systems query for default._domainkey.example2.coms\nTXT records."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expected"</span>: <span class="token string">"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO\\/xJtrPZKskZF8\\/sU0zWGTqKUOErlyJfoJzMDUv3\\/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248\\/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB"</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">"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO\\/xJtrPZKskZF8\\/sU0zWGTqKUOErlyJfoJzMDUv3\\/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248\\/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"example.com: The DKIM version must be \"DKIM1\"."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">"VALID"</span></div></li></ul><span class="token punctuation">}</span></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">"VALID"</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">"valid"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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' PTR records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function validates the pointer records (PTR) for IPv4 and
IPv6 addresses that the account's domains send mail from. It retrieves the
PTR records for each IP address and determines which of the domain'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'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain for which to validate the PTR records.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"validate_current_ptrs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"EmailAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"1.0.0.10.in-addr.arpa"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">"1.1.1.1.1 is not a valid IP address."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"helo"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_address"</span>: <span class="token string">"10.0.0.1"</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">"ns1.example.com"</span></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">"example.com"</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">"10.0.0.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">"state"</span>: <span class="token string">"VALID"</span></div></li></ul><span class="token punctuation">}</span></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">"VALID"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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' DKIM records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes the DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains.</p>
" 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&domain=example2.com&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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_dkim"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"EmailAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">"[REMOVE:TXT@default._domainkey:v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiLMNOpQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO/xJtrPZKskZF8/sU0zWGTqKUOErlyJfoJzMDUv3/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB\\;]"</span><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' SPF records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the the Sender Policy Framework (SPF) records
for one or more domains.</p>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain for which to check the <code>SPF</code> records.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"validate_current_spfs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"EmailAuth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">"(XID rm8h9f) DNS returned SERVFAIL (code 2)\nin response to the systems query for example2.coms\nTXT records."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expected"</span>: <span class="token string">"ip6:0:0:0:0:0:ffff:c0a8:101"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_address"</span>: <span class="token string">"0:0:0:0:0:ffff:c0a8:101"</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">"v=spf1 +a +mx ip6:0:0:0:0:0:ffff:c0a8:101 ~all"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"'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)'"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">"PASS"</span></div></li></ul><span class="token punctuation">}</span></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">"VALID"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>Domain Management / Direct Link Protection (Hotlink)</p>
"><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_hotlink"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<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>
" 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="<p>File types to hotlink protect.</p>
<p><strong>Note:</strong></p>
<p>To protect multiple file types, use a comma-separated list.</p>
" 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"> <!-- --><<!-- -->url<!-- -->><!-- --> </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="<p>The URL to which the system sends hotlinkers.</p>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_hotlink"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_hotlinks"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"jpg,jpeg,gif,png,bmp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"redirect_url"</span>: <span class="token string">"</span><a href="http://redirect.example.com/">http://redirect.example.com/</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">"disabled"</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">"</span><a href="http://example.com/">http://example.com/</a><span class="token string">"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>Domain Management / Domain Information</p>
"><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' hosting configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists user data for the cPanel account'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">"hash"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"hash"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"list"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The function'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"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 string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">"/home/user/public_html/seconddomain.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"seconddomain.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hascgi"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">"/home/user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"192.168.0.128"</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">"0"</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">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">"root"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveradmin"</span>: <span class="token string">"webmaster@seconddomain.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveralias"</span>: <span class="token string">"seconddomain.com www.seconddomain.com www.seconddomain.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"servername"</span>: <span class="token string">"seconddomain.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"addon_domain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usecanonicalname"</span>: <span class="token string">"Off"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"userdirprotect"</span>: <span class="token string">""</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">"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 string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">"/home/user/public_html/subdomain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"exampledomain.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hascgi"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">"/home/user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"192.168.0.128"</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">"0"</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">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">"root"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveradmin"</span>: <span class="token string">"webmaster@subdomain.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveralias"</span>: <span class="token string">"exampledomain.com www.exampledomain.com www.subdomain.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"servername"</span>: <span class="token string">"subdomain.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"addon_domain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usecanonicalname"</span>: <span class="token string">"Off"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"userdirprotect"</span>: <span class="token string">""</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">"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 string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">"/home/user/addondomain/home/dir"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"addondomain.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hascgi"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">"/home/user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"192.168.0.128"</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">"0"</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">"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 string">"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="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">"combined"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">"/usr/local/apache/domlogs/example.com"</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">"\"%{%s}t %I .\\n%{%s}t %O .\""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">"/usr/local/apache/domlogs/example.com-bytes_log"</span></div></li></ul><span class="token punctuation">}</span></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">"/home/user/public_html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hascgi"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">"/home/user"</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">"user"</span></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">"192.168.0.128"</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">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"options"</span>: <span class="token string">"ExecCGI Includes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">"root"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"port"</span>: <span class="token string">"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="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">"/home/user/public_html/cgi-bin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"/cgi-bin/"</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">"/home/user/public_html/cgi-bin/"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"/cgi-bin/"</span></div></li></ul><span class="token punctuation">}</span></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">"webmaster@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveralias"</span>: <span class="token string">"parkeddomain.com www.parkeddomain.com www.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"servername"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"main_domain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usecanonicalname"</span>: <span class="token string">"Off"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"userdirprotect"</span>: <span class="token string">""</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"no_cache_update"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">"root"</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">"parkeddomain.com"</span></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">"parkeddomain.com"</span></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">"parkeddomain.com"</span></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">"webmaster@subdomain.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveralias"</span>: <span class="token string">"addondomain.com www.addondomain.com www.subdomain.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"servername"</span>: <span class="token string">"subdomain.example.com"</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">"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 string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">"/home/user/public_html/sub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"sub.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hascgi"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">"/home/user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"192.168.0.128"</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">"0"</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">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">"root"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveradmin"</span>: <span class="token string">"webmaster@sub.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveralias"</span>: <span class="token string">"www.sub.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"servername"</span>: <span class="token string">"sub.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub_domain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usecanonicalname"</span>: <span class="token string">"Off"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"userdirprotect"</span>: <span class="token string">""</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"addon_domain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usecanonicalname"</span>: <span class="token string">"Off"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"userdirprotect"</span>: <span class="token string">""</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token 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's domains<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DomainInfo"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"addondomain.com"</span></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">"example.com"</span></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">"parkeddomain.com"</span></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">"subdomain.example.com"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's hosting configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain on the cPanel account.</p>
<p><strong>Important:</strong></p>
<p>Do <strong>not</strong> specify an alias (parked domain).</p>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"single_domain_data"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DomainInfo"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"combined"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">"/usr/local/apache/domlogs/example.com"</span></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">"/home/user/public_html/"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"user"</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">"/home/user"</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">"user"</span></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">"192.168.0.128"</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">"ExecCGI Includes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">"root"</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">"/home/user/public_html/cgi-bin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"/cgi-bin/"</span></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">"webmaster@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveralias"</span>: <span class="token string">"parkeddomain.com www.parkeddomain.com www.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"servername"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"main_domain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usecanonicalname"</span>: <span class="token string">"Off"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the built-in subdomain aliases for an account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"main_domain_builtin_subdomain_aliases"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DomainInfo"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"mail"</span>,</div></li><li><div class="hoverable "><span class="token string">"www"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>Domain Management / Domain Redirection</p>
"><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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain from which to redirect.</p>
" 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"> <!-- --><<!-- -->url<!-- -->><!-- --> </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="<p>The URL to which to redirect.</p>
" 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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->url-path<!-- -->><!-- --> </span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"/"</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="<p>A specific page from which to redirect.</p>
" 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">"permanent"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"permanent"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"temp"</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="<p>Whether the redirect is temporary.</p>
<ul>
<li><code>permanent</code></li>
<li><code>temp</code></li>
</ul>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_redirect"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"Htaccess Installed"</span></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="<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>
" 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">""</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="<p>An argument string that contains the arguments of a <code>Redirect</code> or <code>RedirectMatch</code> directives.</p>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" 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't pass this parameter, the system looks up the document root from the <code>domain</code> parameter'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain name.</p>
" 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">""</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="<p>The specific page that redirects visitors.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_redirect"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function retrieves a redirection URL for a domain.</p>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_redirect"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"</span><a href="http://www.domain.com">http://www.domain.com</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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' redirects<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the redirects in an account'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="<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>
" 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="^[a-z0-9_-]{6,18}$"</span></div><div><div html="<p>A Perl regular expression that filters the results. The system matches the regular expression to the <code>sourceurl</code> return value.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_redirects"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"</span><a href="http://redirect.example.com/">http://redirect.example.com/</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"displaydomain"</span>: <span class="token string">"ALL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"displaysourceurl"</span>: <span class="token string">"/marceau.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"docroot"</span>: <span class="token string">"/home/example/public_html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"kind"</span>: <span class="token string">"rewrite"</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">"checked"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"opts"</span>: <span class="token string">"L"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"source"</span>: <span class="token string">"/marceau.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sourceurl"</span>: <span class="token string">"/marceau.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"statuscode"</span>: <span class="token string">"301"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targeturl"</span>: <span class="token string">"</span><a href="http://redirect.example.com/">http://redirect.example.com/</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"permanent"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"urldomain"</span>: <span class="token string">"example.com"</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">"checked"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>The SubDomain module for UAPI.</p>
"><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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The subdomain's document <code>root</code> within the home directory, given as a valid directory path relative to the user's home directory.</p>
<p>This value defaults to the user'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's <a href="https://go.cpanel.net/whmdocsTweakSettings#domains"><em>Tweak Settings</em></a> interface (<em>WHM >> Home >> Server Configuration >> Tweak Settings</em>), this parameter defaults to the <code>/username/</code> path. For example, the <code>username</code> user'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="<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>
" 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="<p>The subdomain name to create.</p>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain on which to create the new subdomain. The domain <strong>must</strong> already exist on the cPanel account.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"addsubdomain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SubDomain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>Domain Management / Virtual Host Information</p>
"><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="<p>This function lists virtual host names for each domain.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WebVhosts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</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">"cpanel"</span>,</div></li><li><div class="hoverable "><span class="token string">"webmail"</span>,</div></li><li><div class="hoverable "><span class="token string">"autodiscover"</span>,</div></li><li><div class="hoverable "><span class="token string">"whm"</span>,</div></li><li><div class="hoverable "><span class="token string">"webdisk"</span></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">"hostname.example.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_ssl_capable_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WebVhosts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</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">"hostname.example.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>Email / Email Accounts</p>
"><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's account name<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<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>
" 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'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"account_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's subdirectories and files<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the mail directory'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'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>An email address, to limit the function&#39;s results.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An email address, to limit the function'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="<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>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"browse_mailbox"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"archive"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fullpath"</span>: <span class="token string">"/home/example/mail/archive"</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">"/home/example/mail"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"relpath"</span>: <span class="token string">"/archive"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"dir"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"The cPanel account's main domain."</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="<p>The email account&#39;s domain. For example, <code>example.com</code> to create <code>user@example.com</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account'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="<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>
" 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="<p>The email account password.</p>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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'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">"The defined system value."</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="<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>
" 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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip the update of the email accounts database'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_pop"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"user+example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's autoresponders total<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"count_auto_responders"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's email account total<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"count_pops"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's outgoing messages<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email address to query.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_held_messages"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's quota<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function changes an email address&#39;s quota.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes an email address'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The email account&#39;s domain. Defaults to the cPanel account&#39;s main domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account's domain. Defaults to the cPanel account'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="<p>The email account username.</p>
" 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="<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>
" 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's quota value is set higher (or unlimited) than
the account's max quota, the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"edit_pop_quota"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sends an email account'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="<p>The email account username or address for which to send client settings.</p>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email address to send client settings.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"dispatch_client_settings"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="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's outgoing mail<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets Exim'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"hold_outgoing"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's autoresponder information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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="<p>The email account name.</p>
" 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">"utf-8"</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="<p>The autoresponder&#39;s <a href="https://en.wikipedia.org/wiki/Character_encoding">character set</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The autoresponder'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_auto_responder"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"This is an autoresponder message."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"charset"</span>: <span class="token string">"UTF-8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"from"</span>: <span class="token string">"User Name"</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">"Autoresponder Subject"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's client settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an email account'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_client_settings"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"username@example.com"</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">"mail.example.com"</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">"username@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display"</span>: <span class="token string">"username@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"domain.com"</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">"mail.example.com"</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">"imap"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inbox_username"</span>: <span class="token string">"username@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mail_domain"</span>: <span class="token string">"mail.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"smtp_host"</span>: <span class="token string">"mail.example.com"</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">"username@example.com"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's default email quota<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_default_email_quota"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's disk usage<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The email account&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account'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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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="<p>The email account username.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_disk_usage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's default email quota in MiB<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_default_email_quota_mib"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's disk usage<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_main_account_disk_usage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"3076 bytes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's outgoing message count<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email address to query.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_held_message_count"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's disk usage in bytes<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_main_account_disk_usage_bytes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's max quota size<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_max_email_quota"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's max quota size in MiB<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_max_email_quota_mib"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's quota<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an email account'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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The email account&#39;s domain. This parameter defaults to the cPanel account&#39;s main domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account's domain. This parameter defaults to the cPanel account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account username. For example, user if the email address is <a href="mailto:user@example.com">user@example.com</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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_pop_quota"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's Webmail settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an email account'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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_webmail_settings"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"mail.example.com"</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">"user@example.com"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's autoresponders<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a domain'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain name.</p>
" 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="<p>A <a href="https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions">Perl Compatible Regular Expression (PCRE)</a> that filters the results.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_auto_responders"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject"</span>: <span class="token string">"Autoresponder Subject"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's default email address<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a domain'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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'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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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="<p>The user whose default addresses to list.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_default_address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's mail domains<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the account'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'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="<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>
" 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'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="<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>
" 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'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_mail_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the cPanel account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip the email database'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="<p>A <a href="https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions">Perl Compatible Regular Expression (PCRE)</a> that filters the results.</p>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude the cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_pops"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login"</span>: <span class="token string">"user@example.com"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the cPanel account'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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'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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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="<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>
" 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&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="<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>
" 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="<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>
" 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'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="<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>
" 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"> <!-- -->>= 1<!-- --> </span></span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"unlimited"</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="<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>
" 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="<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>
" 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="<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>
" 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">"An empty string"</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_pops_with_disk"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"unlimited"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"user@example.com"</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">"None"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"humandiskused"</span>: <span class="token string">"483 bytes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login"</span>: <span class="token string">"user@example.com"</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">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"user"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes an email account'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"the cPanel account's main domain"</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="<p>The email account&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account'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="<p>The email account username or address.</p>
" 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="<p>The email account password.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"passwd_pop"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sends all of the outgoing mail from Exim'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"release_outgoing"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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">"No such person at this address"</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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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">"fwd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"fail"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"blackhole"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"pipe"</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="<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>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_default_address"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"admin@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>This function traces the email delivery route to an email account.</p>
" 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="<p>The email address to which to trace a message delivery path.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"trace_delivery"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"username@example.com"</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">"username@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"aliasfile"</span>: <span class="token string">"/etc/valiases/example.com"</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">"username@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"local_delivery"</span></div></li></ul><span class="token punctuation">}</span></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">"routed"</span></div></li></ul><span class="token punctuation">}</span></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">"routed"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email account address.</p>
" 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="<p>The email account password.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"verify_password"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's autoresponder<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email account.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_auto_responder"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"The cPanel account's main domain."</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="<p>The email account&#39;s domain. For example, <code>example.com</code> if the email address is <code>user@example.com</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account'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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>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.</p>
<ul>
<li><code>passwd</code> — Preserve the mail account's home directory.</li>
<li>Any other value — Remove the mail account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to modify the mail account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_pop"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's autoresponder<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>The contents of the autoresponder message&#39;s <code>Body</code> section.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The contents of the autoresponder message'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">"utf-8"</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="<p>The <a href="https://en.wikipedia.org/wiki/Character_encoding">character set</a>.</p>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The email account&#39;s domain. For example, <code>example.com</code> if the email address is <code>user@example.com</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account'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="<p>The email account name. For example, <code>user</code> if the email address is <code>user@example.com</code>.</p>
" 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="<p>The contents of the autoresponder message&#39;s <code>From:</code> field.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The contents of the autoresponder message'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"> <!-- -->>= 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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->unix_timestamp<!-- -->><!-- --> </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="<p>When to enable the autoresponder.</p>
" 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"> <!-- --><<!-- -->unix_timestamp<!-- -->><!-- --> </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="<p>When to disable the autoresponder. A time that is after the <code>start</code> time.</p>
" 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="<p>The contents of the autoresponder message&#39;s <code>Subject:</code> field.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The contents of the autoresponder message'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_auto_responder"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function imports email accounts from an already uploaded CSV file.</p>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain under which to add the email accounts.</p>
" 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="<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>
" 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">"email"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"fwd"</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"doimport"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CSVImport"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"j.doe@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"OK"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"email"</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">"jdoe@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"The account jdoe@example.com already exists!"</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">"email"</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">"1 error(s) were encountered while importing accounts."</span></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="<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>
" 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'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'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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'</span> -<!-- --> <!-- -->Add a single manual MX redirect entry.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com&domain-1=example1.com&domain-2=example2.com</span> -<!-- --> <!-- -->Add multiple manual MX redirect entries.</li></ul><div><div html="<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>
" 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='mailhostexample'</span> -<!-- --> <!-- -->Add a single manual MX host.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mx_host=mailhostexample&mx_host-1=mailhostexample&mx_host-2=mailhostexample</span> -<!-- --> <!-- -->Add multiple manual MX hosts.</li></ul><div><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain, IPv4, or IPv6 address to redirect the domain value'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_manual_mx_redirects"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"mailhostexample.com"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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'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'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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'</span> -<!-- --> <!-- -->Add a single manual MX redirect entry.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com&domain-1=example1.com&domain-2=example2.com</span> -<!-- --> <!-- -->Add multiple manual MX redirect entries.</li></ul><div><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"unset_manual_mx_redirects"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"mailhostexample.com"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"terminate_mailbox_sessions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"OK"</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="<p>Email / Email Filtering</p>
"><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's email filters total<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"count_filters"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email address that owns the filter.</p>
" 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="<p>The filter&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filter'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_filter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"coffee"</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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email address that owns the filter.</p>
" 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="<p>The filter&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filter'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"enable_filter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"coffee"</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's information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an email filter'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email address that owns the filter.</p>
" 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="<p>The filter&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filter'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_filter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"deliver"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dest"</span>: <span class="token string">"/dev/null"</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">"coffee"</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">"contains"</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">"or"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"part"</span>: <span class="token string">"$message_body"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"val"</span>: <span class="token string">"coconut"</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="<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>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_filters"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dest"</span>: <span class="token string">"/dev/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">"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">"coffee"</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">"contains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"opt"</span>: <span class="token string">"or"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"part"</span>: <span class="token string">"$message_body"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"val"</span>: <span class="token string">"coconut"</span></div></li></ul><span class="token punctuation">}</span></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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all of the cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_filters_backups"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_system_filter_info"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"filter_info.username.yaml.gz"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's email filter order<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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'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="<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>
" 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'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'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="<p>The email address.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"reorder_filters"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email address, for user-level filters. If you do not use this parameter, the function creates an account-level filter.</p>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filter'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">""</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="<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>
" 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="<p>The filter name.</p>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filter'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="<p>The name of an existing filter, to rename it. If you do not use this parameter, the function creates a new filter.</p>
" 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">"and"</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="<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>
" 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="<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>
" 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's spam score value, measured in plus(<code>+</code>) characters.</li>
<li><code>$h_x-Spam-Score:</code> - Match against the message'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'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's body.</li>
<li><code>$message_headers:</code> - Match against the message'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'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"store_filter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function tests mail filters. The function <strong>only</strong> tests filters for the cPanel account's main domain, and only tests against the message's body. 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>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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"trace_filter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"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>"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's email filter<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email address that owns the filter.</p>
" 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="<p>The filter&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filter'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_filter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>Email / Email Forwarding</p>
"><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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain to receive forwarded mail.</p>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain on the cPanel account from which to forward mail.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_domain_forwarder"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"File updated \"/etc/vdomainaliases/example.com\""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>The domain.</p>
" 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="<p>The email address to forward.</p>
" 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">"No such person at this address"</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="<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>
" 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 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="<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>
" 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="<p>The method to use to handle the email address&#39;s mail.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The method to use to handle the email address'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="<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>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_forwarder"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forward"</span>: <span class="token string">"fwdtome@example.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain name.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_domain_forwarder"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's mail forwarder total<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"count_forwarders"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's email forwarder<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The forwarder&#39;s email address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The forwarder'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The forwarder'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_forwarder"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_domain_forwarders"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forward"</span>: <span class="token string">"forwardtome.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's forwarders<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a domain'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain.</p>
" 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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_forwarders"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"forwarded@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forward"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"html_dest"</span>: <span class="token string">"forwarded@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"html_forward"</span>: <span class="token string">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uri_dest"</span>: <span class="token string">"forwarded%40example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uri_forward"</span>: <span class="token string">"user%40example.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_forwarders_backups"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>Email / Email Server Information.</p>
"><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"check_fastmail"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables the system's ability to automatically create mailboxes for a cPanel account.</p>
<p><strong>Note:</strong></p>
<p> When you <strong>enable</strong> the UAPI'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email account address for which to disable mailbox autocreation.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_mailbox_autocreate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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:user+newmailbox@example.com">user+newmailbox@example.com</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="<p>The email account for which to enable mailbox autocreation.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"enable_mailbox_autocreate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's supported character encodings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"fetch_charmaps"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"utf-8"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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's <a href="https://go.cpanel.net/whmdocsManagePlugins"><em>Manage Plugins</em></a> interface (<em>WHM >> Home >> cPanel >> 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"fts_rescan_mailbox"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's supported character encodings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_charsets"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"utf-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">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's mailbox autocreate status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email account address to query.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_mailbox_autocreate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"has_plaintext_authentication"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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'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">"auto"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"auto"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"local"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"secondary"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"remote"</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="<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>
" 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'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The mail exchanger&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger'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">"auto"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"auto"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"local"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"secondary"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"remote"</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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_always_accept"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"auto"</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">"auto"</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">"Auto Detect of MX configuration not possible due to non-resolving MX entries. Defaulting to last known setting: local."</span></div></li></ul><span class="token punctuation">]</span></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">"auto"</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">"auto"</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">"Set Always Accept Status to: local"</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">"Set Always Accept Status to: local"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"stats_db_status"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"active"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>Email / Email Suspensions</p>
"><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="<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>
" 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'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email user&#39;s account name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"suspend_incoming"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>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.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>When you suspend an account, the user'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email user&#39;s account name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"suspend_login"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores a user's ability to log in to their email account.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To suspend a user'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email user&#39;s account name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"unsuspend_login"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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's login credentials or access permissions to their email account.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>To suspend a user'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'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"suspend_outgoing"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email user&#39;s account name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"unsuspend_incoming"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The email account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"unsuspend_outgoing"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>Email / Mail Server Information</p>
"><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="<p>This function retrieves Exim&#39;s SSL port.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves Exim'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_exim_ports_ssl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Chkservd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>This function lists the ports on which Exim listens.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_exim_ports"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Chkservd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>Email / Mailbox Management</p>
"><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's mailbox status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the account&#39;s mailbox size and globally unique identifier (GUID) by folder.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the account'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="<p>The email account for which you you wish to request the status.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_mailbox_status_list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mailboxes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"1234560f0c58d158c92a000044f0d230"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">"INBOX.marla_singer@example_com"</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">"11234560f0c58d158c92a000044f0d23"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">"INBOX.angel_face@example_com"</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">"111234560f0c58d158c92a000044f0d2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">"INBOX.tyler_durden@example_com"</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">"1111234560f0c58d158c92a000044f0d"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">"INBOX.Trash"</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">"11111234560f0c58d158c92a000044f0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">"INBOX.narrator@example_com"</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">"111111234560f0c58d158c92a000044f"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">"INBOX"</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">"1111111234560f0c58d158c92a000004"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">"INBOX.Sent"</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">"11111111234560f0c58d158c92a00000"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">"INBOX.Drafts"</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">"111111111234560f0c58d158c92a0000"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">"INBOX.robert_paulsen@example_com"</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="<p>This function marks the selected mail messages as deleted.</p>
" 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's mailbox.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=example</span> -<!-- --> <!-- -->The cPanel user'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="<p>The email account&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account'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="<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>
" 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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"expunge_mailbox_messages"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mailboxes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function marks the selected mailbox&#39;s messages as deleted.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function marks the selected mailbox'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's mailbox.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=example</span> -<!-- --> <!-- -->The cPanel user'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="<p>The email account&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mailbox'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="<p>The query to select which messages you wish to remove from the mailbox.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"expunge_messages_for_mailbox_guid"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mailboxes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's mailboxes use UTF-8<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function determines whether a cPanel user currently uses UTF-8 character-encoded mailbox names.</p>
" 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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"has_utf8_mailbox_names"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mailboxes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>This function enables or disables UTF-8-encoded mailbox names on Roundcube webmail for a cPanel user&#39;s email accounts.</p>
" 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'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_utf8_mailbox_names"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mailboxes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>Email / Mailing Lists</p>
"><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="<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>
" 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="<p>A list of the administrators to add.</p>
<p><strong>Note:</strong></p>
<p> Separate multiple email addresses with commas.</p>
" 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="<p>The mailing list.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_mailman_delegates"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"admin@example.com, user@example.com"</span></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's mailing list total<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"count_lists"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's Mailman mailing lists to a file<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function exports a cPanel account's Mailman mailing lists into a CSV file.
This file is located in mail/exported_lists under the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"export_lists"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The mailing list.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The mailing list.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"generate_mailman_otp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"LfFYLPRT_UoS4EDi9lGKuOFK8FaWQsozzPYn8WjM3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's mailing list disk usage<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_lists_total_disk_usage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a mailing list'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="<p>The name of a Mailman mailing list on the cPanel account.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_mailman_delegates"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"secondadmin@example.com"</span></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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes a mailing list'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="<p>The full name (including the domain) of a Mailman mailing list on the cPanel account.</p>
" 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="<p>The new password.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"passwd_list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's mailing list privileges<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks an account'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The email address.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"has_delegated_mailman_lists"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's mailing lists<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the account&#39;s Mailman mailing lists.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the account'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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'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="<p>A <a href="https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions">Perl Compatible Regular Expression (PCRE)</a> that filters the results.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_lists"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"public"</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">"172.16.254.1"</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">"19.9\\u00a0KB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"list"</span>: <span class="token string">"list@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"listadmin"</span>: <span class="token string">"admin@example.com,admin2@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"listid"</span>: <span class="token string">"list_example.com"</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="<p>This function removes an account&#39;s mailing list administrative privileges.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes an account'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="<p>list of the administrators to remove.</p>
" 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="<p>The mailing list.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"remove_mailman_delegates"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"secondadmin@example.com"</span></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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies a Mailman mailing list'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="<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>
" 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="<p>Whether the mailing list archive is private.</p>
<ul>
<li><code>1</code> - Private.</li>
<li><code>0</code> - Public.</li>
</ul>
" 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="<p>The mailing list name.</p>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_list_privacy_options"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain.</p>
" 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="<p>The mailing list name.</p>
" 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="<p>The mailing list password.</p>
" 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="<p>Whether the mailing list is private.</p>
<ul>
<li><code>1</code> — Private.</li>
<li><code>0</code> — Public.</li>
</ul>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>Email / Signing and Encryption (GnuPG Keys)</p>
"><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="<p>This function deletes a GnuPG (GPG) key pair.</p>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_keypair"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"GPG"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function exports a GnuPG (GPG) public key.</p>
" 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="<p>The ID of the GPG key.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"export_public_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"GPG"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"-----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"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function exports a GnuPG (GPG) secret key.</p>
" 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="<p>The ID of the GPG secret key that you wish to retrieve.</p>
" 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="<p>The passphrase of the GPG secret key that you wish to retrieve.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"export_secret_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"GPG"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"-----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-----"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function imports a GnuPG (GPG) key.</p>
" 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="<p>The key to import.</p>
<p><strong>Note:</strong></p>
<p>You must URI-encode this value.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"import_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"GPG"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"59E79B6904616529"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's GnuPG public keys<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the GnuPG (GPG) public keys for the
currently-authenticated account.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_public_keys"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"GPG"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"DSA"</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">"1559238435"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires"</span>: <span class="token string">"1590774435"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"C801294347601B8F"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"pub"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"bender (is great) <bender@example.com>"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's GnuPG secret keys<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the GnuPG (GPG) secret keys for the currently-authenticated account.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_secret_keys"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"GPG"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"DSA"</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">"738538C1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sec"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"username (John Doe) <username@example.com>"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function generates a GnuPG (GPG) key. The system saves the key in the user'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'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's Key</span></div><div><div html="<p>A comment about the key.</p>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The user&#39;s email address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user'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="<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>
" 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="<p>The new key&#39;s size, in bytes.</p>
<p><strong>Note:</strong></p>
<p>Large keys require more time to generate.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new key'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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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="<p>The name of the user for whom to generate the key.</p>
" 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="<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>
" 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="<p>The key&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"generate_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"GPG"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>Email / Spam Filtering (Greylisting)</p>
"><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="<p>This function checks whether Greylisting is enabled for the cPanel account.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"has_greylisting_enabled"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"cPGreyList"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>This function enables Greylisting on all of the cPanel account&#39;s domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables Greylisting on all of the cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"enable_all_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"cPGreyList"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"this.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"that.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"theother.com"</span></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">"example.com"</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">"this, that, and the other."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"main"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>This function disables Greylisting on a cPanel account&#39;s domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables Greylisting on a cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_all_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"cPGreyList"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"this.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"that.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"theother.com"</span></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">"example.com"</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">"this, that, the other"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"main"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>This function disables Greylisting on a cPanel account&#39;s selected domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables Greylisting on a cPanel account'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"cPGreyList"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"this.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"that.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"theother.com"</span></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">"example.com"</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">"this, that, the other"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"main"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>This function returns Greylisting&#39;s status for a cPanel account&#39;s domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns Greylisting's status for a cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"cPGreyList"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"this.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"that.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"theother.com"</span></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">"example.com"</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">"this, that, and the other."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"main"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>This function enables Greylisting on a cPanel account&#39;s selected domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables Greylisting on a cPanel account'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"enable_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"cPGreyList"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"example1.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"example2.com"</span></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">"example.com"</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">"example, example1, example2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"main"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>Email / Spam Management</p>
"><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_spam_assassin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"Apache SpamAssassin™ has been disabled."</span></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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_spam_autodelete"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_spam_box"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"enable_spam_box"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"enable_spam_assassin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Retrieve a specific user account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_spam_settings"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"clear_spam_box"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SpamAssassin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="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="<p>This function lists the Apache SpamAssassin™ scores for each symbolic test.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-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="<p>The name of the method called.</p>
" class="sc-epnzzT 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="<p>The name of the module called.</p>
" 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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_symbolic_test_names"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"SpamAssassin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"ACT_NOW_ALL_CAPS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rule_type"</span>: <span class="token string">"body_tests"</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="<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>
" 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'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="<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>
" 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="<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>
" 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 "<code>TEST_NAME SCORE</code>" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"update_user_preference"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SpamAssassin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"username2@example.com"</span></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">"all"</span></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">"ACT_NOW_CAPS 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">"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">"username@example.com"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_user_preferences"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SpamAssassin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"username2@example.com"</span></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">"ACT_NOW_CAPS 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">"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">"username@example.com"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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"> <!-- -->>= 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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_spam_filter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Email"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>Email / Spam Prevention (BoxTrapper)</p>
"><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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_status"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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&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="<p>The filename of the email message to blacklist.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"blacklist_messages"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</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">"example.msg"</span></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">"blacklist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"This is a failure message."</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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to deliver all messages that resemble the <code>queuefile</code> parameter's value.</p>
<ul>
<li><code>1</code> - Deliver all similar messages.</li>
<li><code>0</code> - Don'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The sender'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&queuefile=example1.msg&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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"deliver_messages"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</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">"example.msg"</span></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">"deliverall"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"This is a failure message."</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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_blocklist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"from blocklisted-email\\@domain\\.com"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_ignorelist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"from ignored-email\\@domain\\.com"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's top 200 lines in BoxTrapper queue<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<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>
" 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="<p>The message&#39;s filename.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The message'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"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"</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">"example.msg"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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">"blacklist"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"returnverify"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"verifyreleased"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"verify"</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_email_template"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"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\","</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"ignore_messages"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</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">"example.msg"</span></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">"ignore"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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'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">"blacklist"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"verify"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"verifyreleased"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"returnverify"</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"reset_email_template"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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='ignored-email\@domain\.com' rules-2='from ignored-email2\@domain\.com' rules-3='to domain2\.com'</span> -<!-- --> <!-- -->Set multiple rules.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rules=rules='ignored-email\@domain\.com' rules='from ignored-email2\@domain\.com' rules='to domain2\.com'</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_ignorelist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The template file'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'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's value.</li>
<li>This value cannot exceed four kilobytes (KB).</li>
<li>You <strong>must</strong> URI-encode this parameter'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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">"blacklist"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"returnverify"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"verifyreleased"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"verify"</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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"save_email_template"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's BoxTrapper queued messages<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of messages in the account'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"> <!-- --><<!-- -->unix_timestamp<!-- -->><!-- --> </span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"the current time"</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="<p>The date for which to return queued messages.</p>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_queued_messages"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"queuefile"</span>: <span class="token string">"example.msg"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject"</span>: <span class="token string">"Email Message Subject"</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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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='blocklisted-email\@domain\.com' rules-2='from blocklisted-email2\@domain\.com' rules-3='to domain2\.com'</span> -<!-- --> <!-- -->Set multiple rules.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rules=rules='blocklisted-email\@domain\.com' rules='from blocklisted-email2\@domain\.com' rules='to domain2\.com'</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_blocklist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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&queuefile=ex2.msg&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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"whitelist_messages"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</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">"example.msg"</span></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">"whitelist"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_allowlist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"from allowlisted-email\\@domain\\.com"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's BoxTrapper configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an account'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_configuration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com,user2@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"from_name"</span>: <span class="token string">"User"</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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_forwarders"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user1@example.com, user2@example.com, user3@example.com"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the account'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"> <!-- --><<!-- -->unix_timestamp<!-- -->><!-- --> </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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_log"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"Processing email with trusted transport method."</span></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">"/home/user/etc/example.com/user/boxtrapper/log/05-02-2019.log"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_status"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to delete all messages that resemble the <code>queuefile</code> parameter'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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&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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filename of the email message who'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_messages"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user@example.com"</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">"example.msg"</span></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">"delete"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"(XID d9myfd) The system failed to locate the requested message:"</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_email_templates"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"blacklist"</span>,</div></li><li><div class="hoverable "><span class="token string">"returnverify"</span>,</div></li><li><div class="hoverable "><span class="token string">"verify"</span>,</div></li><li><div class="hoverable "><span class="token string">"verifyreleased"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's BoxTrapper configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies an account'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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="<p>Whether to enable automatic whitelisting for the account.</p>
<ul>
<li><code>1</code> - Enable.</li>
<li><code>0</code> - Disable.</li>
</ul>
" 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"> <!-- --><<!-- -->email-csv<!-- -->><!-- --> </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="<p>A comma-separated list of email addresses that the system uses when it sends messages back to the original message senders.</p>
" 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="<p>The name of the person who owns the email account.</p>
" 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"> <!-- -->>= 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="<p>The number of days to retain log files and queued messages.</p>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to whitelist the email addresses in a message'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"save_configuration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->email<!-- --> ></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="<p>The email addresses to which to forward email messages.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_forwarders"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" 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='allowlisted-email\@domain\.com' rules-2='from allowlisted-email2\@domain\.com' rules-3='to domain2\.com'</span> -<!-- --> <!-- -->Set multiple rules.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rules=rules='allowlisted-email\@domain\.com' rules='from allowlisted-email2\@domain\.com' rules='to domain2\.com'</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_allowlist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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">"deliver"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"deliverall"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"delete"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"deleteall"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"blacklist"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"whitelist"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ignore"</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="<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>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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'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="<p>The filename of the email message to process. To process multiple email messages, pass this parameter multiple times.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"BoxTrapper"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example"</span></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">"(XID 2ymu8k) The system failed to locate the requested message: example.msg"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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">"One or more of the operations failed."</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="<p>Email / Webmail Applications</p>
"><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the account'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">"the server's default theme"</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="<p>The webmail theme.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_webmail_apps"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WebmailApps"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"Roundcube"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <span class="token string">"/webmail/jupiter/images/roundcube_logo.png"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"roundcube"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"/cpsess##########/3rdparty/roundcube/index.php"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>Email / Webmail Sessions</p>
"><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="<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>
" 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="<p>The domain for the Webmail account.</p>
" 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="<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>
" 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'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="<p>The Webmail account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Webmail account'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="<p>The password for the Webmail account.</p>
" 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"> <!-- --><<!-- -->ipv4<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The session's account'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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create_webmail_session_for_mail_user_check_password"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Session"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"hostname.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"session"</span>: <span class="token string">"username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">"/cpsess2462418786"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<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>
" 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'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"> <!-- --><<!-- -->ipv4<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The session'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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create_webmail_session_for_self"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Session"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"hostname.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"session"</span>: <span class="token string">"username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_SELF,728fb86a7df1cf20690c65f349ac3137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">"/cpsess2462418786"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>The domain for the Webmail account.</p>
" 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="<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>
" 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'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="<p>The Webmail account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Webmail account'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"> <!-- --><<!-- -->ipv4<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The session'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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create_webmail_session_for_mail_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Session"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"hostname.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"session"</span>: <span class="token string">"username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">"/cpsess2462418786"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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{'REMOTE_DBOWNER'}</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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create_temp_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Session"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"cpses_reviY3ZSQK"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>Files / FTP Accounts</p>
"><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="<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>
" 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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP user'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'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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>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.</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="<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>
" 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">""</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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'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"> <!-- -->>= 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account'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="<p>The new FTP account username.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to delete the FTP account'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user's associated domain.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the cPanel account'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="<p>The FTP account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user's associated domain.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the cPanel account'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="<p>The FTP account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"ftp_exists"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's quota<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks an FTP account'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="<p>The FTP account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user's associated domain.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_quota"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's welcome message<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_welcome_message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"Greetings, Professor Falken."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A pipe-delimited list of the FTP account types to include in the function'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A pipe-delimited list of the FTP account types to exclude from the function'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_ftp_with_disk"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"476.84"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_diskused"</span>: <span class="token string">"2.34"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"accttype"</span>: <span class="token string">"sub"</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">"/home/user/public_ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"diskquota"</span>: <span class="token string">"476.84"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"diskused"</span>: <span class="token string">"2.34"</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">"477 MB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"humandiskused"</span>: <span class="token string">"2 MB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login"</span>: <span class="token string">"ftpaccount"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reldir"</span>: <span class="token string">"public_ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serverlogin"</span>: <span class="token string">"ftpaccount@example.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's password<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes an FTP account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user's associated domain.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the cPanel account'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="<p>The FTP account&#39;s new password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account'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="<p>The FTP account username.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"passwd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's home directory<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user's associated domain.</p>
<p><strong>Note:</strong></p>
<p>The default value is the cPanel account'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"> <!-- --><<!-- -->path<!-- -->><!-- --> </span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"user@domain/"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account's home directory</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the <code>user@domain</code> subdirectory in the cPanel account'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="<p>The FTP account username.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_homedir"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's quota<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes an FTP account'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user's associated domain.</p>
<p><strong>Note:</strong></p>
<p>The default value is the cPanel account'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="<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>
" 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"> <!-- -->>= 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="<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>
" 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="<p>The FTP account username.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_quota"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of the FTP account types to include in the function'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of the FTP account types to exclude from the function'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/user/public_html/ftp/"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"main"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"ftpaccount"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>The cPanel account&#39;s new FTP welcome message.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_welcome_message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>Files / FTP Server Settings</p>
"><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"allows_anonymous_ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"allows_anonymous_ftp_incoming"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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's information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the extended information about the server&#39;s FTP daemon.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the extended information about the server'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_ftp_daemon_info"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"pure-ftpd"</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's port<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_port"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<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>
" 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">"all"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username for the session'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"kill_session"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's active sessions<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the FTP server'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_sessions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"pure-ftpd (IDLE)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host"</span>: <span class="token string">"localhost"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login"</span>: <span class="token string">"Tue Apr 23 16:23:23 2020"</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">"IDLE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"ftpaccount"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>Whether to enable or disable anonymous FTP logins.</p>
<ul>
<li><code>1</code> - Enable.</li>
<li><code>0</code> - Disable.</li>
</ul>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_anonymous_ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"server_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"pure-ftpd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_anonymous_ftp_incoming"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>Files / Image Tools</p>
"><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="<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>
" 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="<p>The image file to convert, relative to the cPanel account&#39;s <code>/home</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The image file to convert, relative to the cPanel account'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="<p>The format to which to convert the images.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"convert_file"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ImageManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/cptest1/images/myimage.png"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<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>
" 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'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="<p>The percentage by which to reduce the thumbnails&#39; height.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The percentage by which to reduce the thumbnails' 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="<p>The percentage by which to reduce the thumbnails&#39; width.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The percentage by which to reduce the thumbnails' 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create_thumbnails"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ImageManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/cptest1/public_html/images/610_290.jpg"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"too many pixels"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thumbnail_file"</span>: <span class="token string">"/home/cptest1/public_html/images/thumbnails/tn_610_290.jpg"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_dimensions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ImageManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<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>
" 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"> <!-- -->>= 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="<p>The height to which to set the image size.</p>
" 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="<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>
" 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'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="<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>
" 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't pass this parameter, the function doesn't save
a copy of the original image.</li>
<li>Use the absolute filepath or a filepath relative to the user'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"> <!-- -->>= 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="<p>The width to which to set the image size.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"resize_image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ImageManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"/home/cptest1/images/myimage.jpg"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>Files / Manage Files</p>
"><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="<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>
" 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="<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>
" 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="<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>
" 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="<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>
" 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's value to <code>1</code>, you <strong>must</strong> set the <code>path</code>
parameter'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="<p>The prefix of the paths to complete.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"autocompletedir"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Fileman"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"public_ftp"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function purges content from the <code>.trash</code> folder in the user'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"> <!-- -->>= 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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"empty_trash"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Fileman"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a file'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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The file path to the directory that contains the selected file.</p>
" 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="<p>The file to retrieve.</p>
" 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">"_DETECT_"</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="<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>
" 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">"_LOCALE_"</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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to update the file's HTML document encoding.</p>
<ul>
<li><code>1</code> — Update the file's HTML document encoding.</li>
<li><code>0</code> — Don't update the file'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_file_content"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Fileman"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"`hi`"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dir"</span>: <span class="token string">"/home/user/public_html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filename"</span>: <span class="token string">"example.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"from_char"</span>: <span class="token string">"UTF-8"</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">"/home/user/public_html/example.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"to_char"</span>: <span class="token string">"UTF-8"</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="<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>
" 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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return the file's MIME type.</p>
<ul>
<li><code>1</code> - Return the file's MIME type.</li>
<li><code>0</code> - Do <strong>not</strong> return the file'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to parse the file owner's read and write permissions.</p>
<ul>
<li><code>1</code> - Parse the file owner's read and write permissions.</li>
<li><code>0</code> - Do <strong>not</strong> parse the file owner'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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The directory from which to list files.</p>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_file_information"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Fileman"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/user"</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">"cgi-bin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fullpath"</span>: <span class="token string">"/home/user/public_html/cgi-bin"</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">"5 KB"</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">"publichtml"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mimetype"</span>: <span class="token string">"text/plain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mode"</span>: <span class="token string">"16872"</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">"/home/user/public.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rawmimename"</span>: <span class="token string">"text/plain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rawmimetype"</span>: <span class="token string">"text/plain"</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">"file"</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="<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>
" 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="<p>The file&#39;s contents.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The file'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="<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>
" 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="<p>The file&#39;s current <a href="https://en.wikipedia.org/wiki/Character_encoding">character set encoding</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The file'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="<p>The <a href="https://en.wikipedia.org/wiki/Character_encoding">character set encoding</a> in which to encode the file.</p>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"transcode"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Fileman"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"ASCII"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content"</span>: <span class="token string">"hi"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<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>
" 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="<p>The directory from which to list files.</p>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return the file'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to parse the file owner'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="<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>
" 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="<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>
" 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'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="<p>A comma-separated list of files to return.</p>
<p>If you do not use this parameter, the function returns all files.</p>
" 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="<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>
" 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'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="<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>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Fileman"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/user"</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">"cgi-bin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fullpath"</span>: <span class="token string">"/home/user/public_html/cgi-bin"</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">"5 KB"</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">"text-plain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mimetype"</span>: <span class="token string">"text/plain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mode"</span>: <span class="token string">"16877"</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">"/home/user/public.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rawmimename"</span>: <span class="token string">"text-plain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rawmimetype"</span>: <span class="token string">"text/plain"</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">"file"</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">"/home/user"</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">"cgi-bin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fullpath"</span>: <span class="token string">"/home/user/public_html/cgi-bin"</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">"5 KB"</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">"text-plain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mimetype"</span>: <span class="token string">"text/plain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mode"</span>: <span class="token string">"16877"</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">"/home/user/public.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rawmimename"</span>: <span class="token string">"text-plain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rawmimetype"</span>: <span class="token string">"text/plain"</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">"file"</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="<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>
" 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="<p>The new file&#39;s contents. If you do <strong>not</strong> use this parameter, the function creates a blank file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new file'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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" 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'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="<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>
" 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="<p>The files to retrieve.</p>
" 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">"UTF-8"</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="<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>
" 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'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">"UTF-8"</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="<p>The <a href="https://en.wikipedia.org/wiki/Character_encoding">character set encoding</a> in which to encode the file.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"save_file_content"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Fileman"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"UTF-8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"/home/user/public_html/example.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"to_charset"</span>: <span class="token string">"ASCII"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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'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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"upload_files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Fileman"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filename"</span>: <span class="token string">"example.png"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>Files / WebDisk Settings</p>
"><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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to recursively delete the Web Disk account'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The Web Disk account username.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WebDisk"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes the Web Disk account'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="<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>
" 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="<p>The Web Disk account&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Web Disk account'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The Web Disk account username.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_password"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WebDisk"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The Web Disk account&#39;s home directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Web Disk account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to set the Web Disk directory'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The Web Disk account username.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_homedir"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WebDisk"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes the Web Disk home directory'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">"ro"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"rw"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Web Disk account'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The Web Disk account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Web Disk account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_permissions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WebDisk"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>GIT Management / Deployment Settings</p>
"><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="<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>
" 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'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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The repository&#39;s directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The repository'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"VersionControlDeployment"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"12"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log_path"</span>: <span class="token string">"/home/user/.cpanel/logs/vc_1525289545.785367_git_deploy.log"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">"/home/username/example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">"/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"task_id"</span>: <span class="token string">"00000000/5a9ec8dd4c345d"</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">"1525289545.16293"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>The <a href="https://go.cpanel.net/whmdocsTaskQueueMonitor">Task Queue system&#39;s</a> task ID number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://go.cpanel.net/whmdocsTaskQueueMonitor">Task Queue system'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"VersionControlDeployment"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"retrieve"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"VersionControlDeployment"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/user/.cpanel/logs/vc_1525289448.759720_git_deploy.log"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">"/home/username/example"</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">"Jane Doe <jane.doe@example.com>"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"branch"</span>: <span class="token string">"master"</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">"2fd4e1c67a2d28fced849ee1bb76e7391b93eb12"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"This is a commit."</span></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">"/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"task_id"</span>: <span class="token string">"00000000/5aea11e886a5d8"</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">"1525289448.83553"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"canceled"</span>: <span class="token string">"1525289448.83553"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed"</span>: <span class="token string">"1525289448.83553"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"queued"</span>: <span class="token string">"1525289448.83553"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"succeeded"</span>: <span class="token string">"1525289448.83553"</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="<p>GIT Management / Repository Management</p>
"><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="<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>
" 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 & 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="<p>The new repository&#39;s display name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new repository'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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" 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'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={"remote_name":"origin","url":"ssh://clone.domain.com/cloneme"}</span></div><div><div html="<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>
" 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">"git"</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"VersionControl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"master"</span>,</div></li><li><div class="hoverable "><span class="token string">"olive"</span></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">"master"</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">"</span><a href="https://user@example.com/home/user/example">https://user@example.com/home/user/example</a><span class="token string">"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"ssh://user@example.com/home/user/example"</span></div></li></ul><span class="token punctuation">]</span></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">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">"/home/user/public_html/example"</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">"remote"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"</span><a href="http://user@domain.com/home/user/domain">http://user@domain.com/home/user/domain</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"create"</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">"/home/username/.cpanel/logs/vc_1234567890.123456_git_deploy.log"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">"/home/user/example"</span></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">"00000000/5a9ec8dd4c345d"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">"/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subsystem"</span>: <span class="token string">"VersionControl"</span></div></li></ul><span class="token punctuation">}</span></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">"git"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies a Git™ repository's basic settings. For more information about support
for version control in cPanel & 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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The repository'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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The absolute directory path that contains the repository to update.</p>
" 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={"remote_name":"origin"}</span></div><div><div html="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"update"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"VersionControl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"master"</span></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">"master"</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">"</span><a href="https://user@example.com/home/user/example">https://user@example.com/home/user/example</a><span class="token string">"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"ssh://user@example.com/home/user/example"</span></div></li></ul><span class="token punctuation">]</span></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">"User Name <user.name@example.com>"</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">"2fd4e1c67a2d28fced849ee1bb76e7391b93eb121"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"I'm committing some particularly cromulent code."</span></div></li></ul><span class="token punctuation">}</span></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">"Jane Doe <jane.doe@example.com>"</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">"2fd4e1c67a2d28fced849ee1bb76e7391b93eb12"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"I'm committing some particularly cromulent code."</span></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">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">"/home/user/example"</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">"create"</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">"/home/user/example"</span></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">"00000000/5a9ec8dd4c345d"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subsystem"</span>: <span class="token string">"VersionControl"</span></div></li></ul><span class="token punctuation">}</span></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">"git"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a cPanel account's Git™ repository. For more information about
support for version control in cPanel & 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="<p>The absolute directory path in the user&#39;s <code>home</code> directory containing the repository to delete.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute directory path in the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"VersionControl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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 & 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>\ * | " ' < > & @ ` $ { } [ ] ( ) ; ? : = % #</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">"*"</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"retrieve"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"VersionControl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"master"</span></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">"master"</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">"</span><a href="https://user@example.com/home/user/example">https://user@example.com/home/user/example</a><span class="token string">"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"ssh://user@example.com/home/user/example"</span></div></li></ul><span class="token punctuation">]</span></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">"User Name <user.name@example.com>"</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">"2fd4e1c67a2d28fced849ee1bb76e7391b93eb12"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"I'm committing some particularly cromulent code."</span></div></li></ul><span class="token punctuation">}</span></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">"Jane Doe <jane.doe@example.com>"</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">"2fd4e1c67a2d28fced849ee1bb76e7391b93eb12"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"I'm committing some particularly cromulent code."</span></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">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">"/home/user/example"</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">"create"</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">"/home/user/.cpanel/logs/vc_1526305129.123456_git_create.log"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">"/home/user/example"</span></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">"00000000/5a9ec8dd4c345d"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">"/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subsystem"</span>: <span class="token string">"VersionControl"</span></div></li></ul><span class="token punctuation">}</span></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">"git"</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">"master"</span></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">"master"</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">"June Due <june.due@example2.com>"</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">"</span><a href="https://user@example.com/home/user/example">https://user@example.com/home/user/example</a><span class="token string">"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"ssh://user@example.com/home/user/example"</span></div></li></ul><span class="token punctuation">]</span></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">"4ee0b73ddf78213c41fcc185acfab68ced99046d"</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">"User Name <user.name@example.com>"</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">"2fd4e1c67a2d28fced849ee1bb76e7391b93eb12"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"I'm committing some particularly cromulent code."</span></div></li></ul><span class="token punctuation">}</span></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">"My code makes more sense, actually."</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">"create"</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">"/home/user/.cpanel/logs/vc_1526305129.123456_git_create.log"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">"/home/user/example"</span></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">"00000000/5a9ec8dd4c345d"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">"/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subsystem"</span>: <span class="token string">"VersionControl"</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">"example2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">"/home/user/example2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"git"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>MySQL and MariaDB / Database Information</p>
"><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns information about the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_server_information"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"192.0.2.1"</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">"5.6.23"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns information about the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"locate_server"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"192.0.2.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/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="<p>MySQL and MariaDB / Database Management</p>
"><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"update_privileges"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The database&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"check_database"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"OK"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg_type"</span>: <span class="token string">"status"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"table"</span>: <span class="token string">"table1"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>The new database&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new database'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="<p>The desired prefix size.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create_database"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The database&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"dump_database_schema"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"-- 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"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>The database&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_database"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_databases"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user_db"</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">"db_user"</span>,</div></li><li><div class="hoverable "><span class="token string">"db2_user"</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="<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>
" 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 & WHM "renames" 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's original state.
If the restoration process fails, the API function'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"> <!-- --><= 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database'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 & 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="<p>The database&#39;s current name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"rename_database"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The database&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"repair_database"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"OK"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg_type"</span>: <span class="token string">"status"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"table"</span>: <span class="token string">"table1"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"setup_db_and_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"cpuser_wp_gwl7vpix28owo855yjomc7rsghkbjv0d0kf45kcvzip9tyxw9kdd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"database_user"</span>: <span class="token string">"cpuser_wp_dji1jdt7nhjiwjcjju45"</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">";1t/U:wnFkCRL9q68]/+<TX=.C#7]n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hostname"</span>: <span class="token string">"localhost"</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="<p>MySQL and MariaDB / Remote Databases</p>
"><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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote MySQL server'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="<p>note that describes the remote MySQL server.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_host_note"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function authorizes a remote MySQL® host to access the account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote MySQL server'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_host"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the notes associated with the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_host_notes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"The combination on my luggage"</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">"Located somewhere in the Ford Galaxy"</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">"Located on Spaceball 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/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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a remote MySQL® host's access to the account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote MySQL server'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_host"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>MySQL and MariaDB / User Management</p>
"><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="<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>
" 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="<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>
" 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's username and an underscore (<code>_</code>). The server only applies the first eight characters of the cPanel account'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's username and an underscore (<code>_</code>). The server only applies the first eight characters of the cPanel account'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's username and an underscore (<code>_</code>). The server only applies the first eight characters of the cPanel account'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="<p>The new user&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new user'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="<p>The desired prefix size.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The MySQL user&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a MySQL® database'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_restrictions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user_"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a database user'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>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.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_routines"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"cptest_newdb.hello"</span>,</div></li><li><div class="hoverable "><span class="token string">"cptest_newdb.my_routine"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_users"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user_database1"</span>,</div></li><li><div class="hoverable "><span class="token string">"user_database2"</span></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">"user1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"example_user1"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user'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's username and an underscore (<code>_</code>). The server only applies the first eight characters of the cPanel account'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's username and an underscore (<code>_</code>). The server only applies the first eight characters of the cPanel account'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's username and an underscore (<code>_</code>). The server only applies the first eight characters of the cPanel account'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="<p>The user&#39;s current name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"rename_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a MySQL® database user'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="<p>The database name.</p>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_privileges_on_database"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"CREATE"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function revokes a MySQL® database user'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="<p>The database&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"revoke_access_to_database"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets a MySQL® database user'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database'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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_privileges_on_database"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets a MySQL® database user'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="<p>The user&#39;s new password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user'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="<p>The MySQL database user.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_password"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>The Pushbullet module for UAPI.</p>
"><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="<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>
" 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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"send_test_message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Pushbullet"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"554d2cbd-efe61da3cacb"</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">"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."</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">"self"</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">"ujw5ScArtjUsjAeRXXMLGS"</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">"user@example.com"</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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"receiver_iden"</span>: <span class="token string">"ujw5ScArtjU"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sender_email"</span>: <span class="token string">"user@example.com"</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">"user@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sender_iden"</span>: <span class="token string">"ujw5ScArtjU"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sender_name"</span>: <span class="token string">"Firstname Lastname"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">"Test message (ID: 555a3994-173a4a271062d)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"note"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>The NVData module for UAPI.</p>
"><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="<p>Optional Applications / Antivirus Protection (ClamAV)</p>
"><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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_scan_paths"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ClamScanner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"home"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"Scan Entire Home Directory"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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">"home"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mail"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"public_html"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"public_ftp"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of directory to scan.</p>
<ul>
<li><code>home</code> — User's entire home directory</li>
<li><code>mail</code> — User's email directory</li>
<li><code>public_html</code> — User's web directory</li>
<li><code>public_ftp</code> — User'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"start_scan"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ClamScanner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_infected_files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ClamScanner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/username/infected_file.txt"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"virus_type"</span>: <span class="token string">"Eicar-Signature"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_scan_status"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ClamScanner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/username/afilename.txt"</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">"/home/username/afile/witha/virus.txt"</span>,</div></li><li><div class="hoverable "><span class="token string">"/home/username/we/gotcha.exe"</span></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">"1608593571"</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="<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>
" 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="<p>The user provides the actions to perform on each specific infected file found in the scan.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"ignore"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"home/virus1"</span>: <span class="token string">"delete"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"home/virus2"</span>: <span class="token string">"quarantine"</span></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">"disinfect_files"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ClamScanner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/user/.clamavconnector.disinfection.log"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"task_id"</span>: <span class="token string">"00000000/5a9ec8dd4c345d"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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 'result{data}{details}' 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"> <!-- -->>= 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"check_disinfection_status"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ClamScanner"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/user/virus"</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">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">"deleted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"step"</span></div></li></ul><span class="token punctuation">}</span></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">"/home/user/.clamavconnector.disinfection.log"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"done"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>Optional Applications / Calendar and Contacts (DAV)</p>
"><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="<p>This function enables the shared global address book for the current cPanel account&#39;s webmail accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables the shared global address book for the current cPanel account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>cPanel account username or a Webmail user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"enable_shared_global_addressbook"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DAV"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>This function checks whether the shared global address book is enabled on the current cPanel account&#39;s webmail accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the shared global address book is enabled on the current cPanel account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>cPanel account user name or a Webmail user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"has_shared_global_addressbook"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DAV"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>This function disables the shared global address book for the current cPanel account&#39;s webmail accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables the shared global address book for the current cPanel account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>cPanel account username or a Webmail user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_shared_global_addressbook"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DAV"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>This function returns the connection information to set up the CalDAV and CardDAV clients.</p>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_calendar_contacts_config"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DAV"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"username"</span></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">"Custom calendar 1."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Calendar 1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"</span><a href="http://example.com:2079/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1">http://example.com:2079/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"Custom address book 1."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Custom 1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"</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">"</span></div></li></ul><span class="token punctuation">}</span></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">"</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">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_server"</span>: <span class="token string">"</span><a href="http://example.com:2079/rpc/principal/example">http://example.com:2079/rpc/principal/example</a><span class="token string">"</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">"</span><a href="http://example.com:2079">http://example.com:2079</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"Custom calendar 2."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Calendar 2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"</span><a href="http://example.com:2080/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1">http://example.com:2080/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"Custom address book 2."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Address book 2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"</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">"</span></div></li></ul><span class="token punctuation">}</span></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">"</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">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_server"</span>: <span class="token string">"</span><a href="http://example.com:2080/rpc/principal/example">http://example.com:2080/rpc/principal/example</a><span class="token string">"</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">"</span><a href="https://example.com:2080">https://example.com:2080</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"username"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function checks whether the DAV service is enabled.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"is_dav_service_enabled"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DAV"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"is_horde_enabled"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DAV"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>This function adds a share for the specified calendar.</p>
" 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="<p>The calendar to share.</p>
" 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="<p>The person to whom you will share the calendar.</p>
" 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="<p>The owner of the calendar, who wishes to share it to another user.</p>
" 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="<p>If set, the provided access will be read-only.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_delegate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CPDAVD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>This function lists the sharing configuration in calendars for this account.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_delegates"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CPDAVD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"calendar"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"calname"</span>: <span class="token string">"cPanel CalDAV Calendar"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delegatee"</span>: <span class="token string">"second@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delegator"</span>: <span class="token string">"first@example.com"</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="<p>This function lists the users that are available for use with CalDAV and CardDAV</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_users"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CPDAVD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"Default Address Book automatically created for your account."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"displayname"</span>: <span class="token string">"cPanel CardDAV Address Book"</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">"VADDRESSBOOK"</span></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">"#ff6c2c"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Default Calendar automatically created for your account."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"displayname"</span>: <span class="token string">"cPanel CalDAV Calendar"</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">"VCALENDAR"</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="<p>This function creates, updates, or deletes a collection.</p>
" 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="<p>The owner of the calendar.</p>
" 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">"create"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"update"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"delete"</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="<p>The action to perform (create, update, or delete a collection).</p>
" 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="<p>The color of the calendar, if applicable.</p>
" 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">"calendar"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"tasks"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"addressbook"</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="<p>The collection type.</p>
" 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="<p>The description of the collection.</p>
" 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="<p>The name of the collection. Required when creating a collection.</p>
" 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="<p>The path to the collection.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"manage_collection"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CPDAVD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>This function removes a share for the specified calendar.</p>
" 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="<p>The calendar that was shared.</p>
" 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="<p>The person to whom the calendar was shared.</p>
" 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="<p>The owner of the calendar, who wishes to remove the sharing.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"remove_delegate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CPDAVD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>This function updates a share for the specified calendar.</p>
" 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="<p>The calendar to share.</p>
" 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="<p>The person to whom you will share the calendar.</p>
" 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="<p>The owner of the calendar, who wishes to change the details of the sharing.</p>
" 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="<p>If set, the provided access will be read-only.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"update_delegate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CPDAVD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>Optional Applications / Calendar and Contacts Server</p>
"><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a delegate from another user'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The user from whom you wish to remove delegation rights.</p>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The calendar&#39;s owner.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The calendar'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"remove_delegate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CCS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="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's calendar users<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_users"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CCS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"0882362A-0B98-11E8-BAF5-D988266709C1"</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">"96F1EB2F-A501-11EA-A3EF-A553B2E4FFA8"</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">"195C8A51-E1B3-11E6-8715-F54FA4E00DDD"</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">"028F4AB1-0F1A-11E7-AEC7-E08FECEC8036"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates the delegation of a user'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The user to whom you delegated the calendar.</p>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The calendar&#39;s owner.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The calendar'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"update_delegate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CCS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function delegates a user'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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The user to whom you wish to delegate the calendar.</p>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </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="<p>The calendar&#39;s owner.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The calendar'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_delegate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CCS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="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's calendar delegates<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_delegates"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CCS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"delegatee@cptest.test"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delegator"</span>: <span class="token string">"delegator@cptest.test"</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="<p>Optional Applications / cPanel Addons (cPAddons)</p>
"><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="<p>This function lists an account&#39;s available cPAddons.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_available_addons"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"cPAddons"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"WordPress (cPanel)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"cPanel::Blogs::WordPress"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists a cPAddons instance&#39;s settings.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a cPAddons instance'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_instance_settings"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"cPAddons"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"cPanel::Blogs::WordPressX"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_user"</span>: <span class="token string">"string"</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">"example_wp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_type"</span>: <span class="token string">"mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_user"</span>: <span class="token string">"example_wp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installdir"</span>: <span class="token string">"/home/example/public_html/wordpress"</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">"</span><a href="http://example.com/wordpress/">http://example.com/wordpress/</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function lists an account&#39;s deployed cPAddons instances.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account'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="<p>The cPAddon for which to return the instances data.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_addon_instances"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"cPAddons"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"cPanel::Blogs::WordPressX"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installdir"</span>: <span class="token string">"/home/example/public_html/wordpress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instance"</span>: <span class="token string">"cPanel::Blogs::WordPressX.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"unique_id"</span>: <span class="token string">"cPanel::Blogs::WordPressX.0.1486754861"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>Optional Applications / WordPress Manager Backups</p>
"><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="<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>
" 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="<p>The WordPress site&#39;s URL without the protocol prefix.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress site'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"cancel"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressBackup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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' backup status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"any_running"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressBackup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"null"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"backup"</span></div></li></ul><span class="token punctuation">}</span></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">"/sse/WordPressBackup"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>The WordPress site&#39;s URL <strong>without</strong> the protocol prefix.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress site'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"cleanup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressBackup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>The WordPress site&#39;s URL <strong>without</strong> the protocol prefix.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress site'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_available_backups"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressBackup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com__2018-10-10T10:53:31-0500.tar.gz"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"/home/example/wordpress-backups/example.com__2018-10-10T10:53:31-0500.tar.gz"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site"</span>: <span class="token string">"example.com"</span></div></li></ul><span class="token punctuation">}</span></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">"/home/example/wordpress-backups"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>The WordPress site&#39;s URL <strong>without</strong> <code>http://</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress site'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"is_running"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressBackup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com__2018-10-10T10:53:31-0500"</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="<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>
" 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="<p>The WordPress site&#39;s URL without the protocol prefix.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress site'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"start"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressBackup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com__2018-10-10T10:53:31-0500"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">"/sse/WordPressBackup"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The file path to the backup archive.</p>
" 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="<p>The WordPress site&#39;s URL to restore.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress site'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"start"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressRestore"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com__2018-11-15T08:03:22-0600"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"restore"</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's temporary files<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>The WordPress site&#39;s URL <strong>without</strong> the protocol prefix.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress site'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"cleanup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressRestore"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>Optional Applications / WordPress Manager Settings</p>
"><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates a WordPress® cPAddon instance'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPAddon instance'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="<p>The cPAddon instance&#39;s new administrator password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPAddon instance'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"change_admin_password"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressInstanceManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The scan’s unique ID.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"cleanup_scan"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressInstanceManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>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.</p>
<p><strong>Important:</strong></p>
<p> This function changes the instance'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="<p>Whether to enable automatic updates for major releases.</p>
<ul>
<li><code>1</code> - Enable.</li>
<li><code>0</code> - Disable.</li>
</ul>
" 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="<p>Whether to enable automatic updates for minor releases.</p>
<ul>
<li><code>1</code> - Enable.</li>
<li><code>0</code> - Disable.</li>
</ul>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPAddon instance'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"configure_autoupdate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressInstanceManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_name"</span>: <span class="token string">"cPanel::Blogs::WordPressX"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_type"</span>: <span class="token string">"modern"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_url"</span>: <span class="token string">"example.com/wordpress-41/wp-login.php"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_username"</span>: <span class="token string">"wpadmin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"available_version"</span>: <span class="token string">"4.9.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"current_version"</span>: <span class="token string">"4.9.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_name"</span>: <span class="token string">"example_wp1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_prefix"</span>: <span class="token string">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_server"</span>: <span class="token string">"localhost"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_type"</span>: <span class="token string">"mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_username"</span>: <span class="token string">"example_wp1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_path"</span>: <span class="token string">"/home/example/public_html/wordpress-41"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">"/home/example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"cPanel__Blogs__WordPress.1.1509732223"</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">"4.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"migrated_from"</span>: <span class="token string">"cPanel::Blogs::WordPress"</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">"wordpress-41"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site_url"</span>: <span class="token string">"example.com/wordpress-41"</span></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">"/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_name"</span>: <span class="token string">"cPanel::Blogs::WordPress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_type"</span>: <span class="token string">"legacy"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_url"</span>: <span class="token string">"example.com/wordpress-41/wp-login.php"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_username"</span>: <span class="token string">"wpadmin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"available_version"</span>: <span class="token string">"4.9.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"current_version"</span>: <span class="token string">"4.9.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_name"</span>: <span class="token string">"example_wp1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_prefix"</span>: <span class="token string">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_server"</span>: <span class="token string">"localhost"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_type"</span>: <span class="token string">"mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_username"</span>: <span class="token string">"example_wp1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_path"</span>: <span class="token string">"/home/example/public_html/wordpress-41"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">"/home/example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"cPanel__Blogs__WordPress.1.1509732223"</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">"4.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">"wordpress-41"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site_url"</span>: <span class="token string">"example.com/wordpress-41"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the WordPress Manager plugin'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_api_version"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressInstanceManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"1.0.1-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-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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_instances"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressInstanceManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_name"</span>: <span class="token string">"cPanel::Blogs::WordPressX"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_type"</span>: <span class="token string">"modern"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_url"</span>: <span class="token string">"example.com/wp-login.php"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_username"</span>: <span class="token string">"admin"</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">"example_wp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_prefix"</span>: <span class="token string">"wp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_server"</span>: <span class="token string">"localhost"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_type"</span>: <span class="token string">"mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_username"</span>: <span class="token string">"example_wp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_path"</span>: <span class="token string">"/home/example/public_html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">"/home/example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"cPanel__Blogs__WordPressX.0.1528208546"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"import_guid"</span>: <span class="token string">"8AF1767E-68CD-11E8-90D1-96B06D626D05"</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">"4.9.6"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"migrated_from"</span>: <span class="token string">"cPanel::Blogs::WordPress"</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">" "</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site_url"</span>: <span class="token string">"example.com"</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="<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>
" 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"> <!-- -->>= 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="<p>The length of time in seconds to cache the database between requests to wordpress.org.</p>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_latest_wordpress_version_from_wordpress_org"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressInstanceManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a WordPress® instance'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress instance'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_instance_by_id"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressInstanceManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_name"</span>: <span class="token string">"cPanel::Blogs::WordPressX"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_type"</span>: <span class="token string">"modern"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_url"</span>: <span class="token string">"example.com/wp-login.php"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_username"</span>: <span class="token string">"admin"</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">"admin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_email"</span>: <span class="token string">"admin@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_login"</span>: <span class="token string">"admin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_nicename"</span>: <span class="token string">"admin"</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">"4.9.6"</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">"4.9.5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_name"</span>: <span class="token string">"example_wp2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_prefix"</span>: <span class="token string">"wp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_server"</span>: <span class="token string">"localhost"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_type"</span>: <span class="token string">"mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_username"</span>: <span class="token string">"example_wp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_path"</span>: <span class="token string">"/home/example/public_html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">"/home/example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"cPanel__Blogs__WordPressX.0.1528208546"</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">"4.7.2"</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">" "</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site_url"</span>: <span class="token string">"example.com/wordpress"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_scan_results"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressInstanceManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_name"</span>: <span class="token string">"cPanel::Blogs::WordPressX"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_type"</span>: <span class="token string">"modern"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_url"</span>: <span class="token string">"example.com/wp-login.php"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_username"</span>: <span class="token string">"admin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"available_version"</span>: <span class="token string">"4.9.5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"current_version"</span>: <span class="token string">"4.9.5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_name"</span>: <span class="token string">"example_wp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_prefix"</span>: <span class="token string">"wp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_server"</span>: <span class="token string">"localhost"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_type"</span>: <span class="token string">"mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_username"</span>: <span class="token string">"example_wp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_path"</span>: <span class="token string">"/home/example/public_html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">"/home/example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"cPanel__Blogs__WordPressX.0.1528208546"</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">"4.9.6"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rel_path"</span>: <span class="token string">"public_html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site_url"</span>: <span class="token string">"example.com"</span></div></li></ul><span class="token punctuation">}</span></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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"is_installable_addon_available"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressInstanceManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>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.</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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"start_scan"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressInstanceManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"B3A27B96-51F7-11E8-92E3-CC90C4F823F0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log"</span>: <span class="token string">"/home/example/.cpanel/plugins/wordpress/scans/B3A27B96-51F7-11E8-92E3-CC90C4F823F0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">"/sse/WordPressScan/B3A27B96-51F7-11E8-92E3-CC90C4F823F0"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"cancel_scan"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressInstanceManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>PostgreSQL / Database Management</p>
"><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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create_database"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_restrictions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example_"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>The database&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_database"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_databases"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"user_db"</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">"db_user"</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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"rename_database"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>PostgreSQL / User Management</p>
"><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="<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>
" 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 >> Databases >> 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"update_privileges"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user'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="<p>The new user&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The PostgreSQL user&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The PostgreSQL user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"grant_all_privileges"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_users"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example_user1"</span>,</div></li><li><div class="hoverable "><span class="token string">"example_user2"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"rename_user_no_password"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"revoke_all_privileges"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes a PostgreSQL® database user'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="<p>The user&#39;s new password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_password"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user'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="<p>The database user&#39;s new password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"rename_user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>The Bandwidth module for UAPI.</p>
"><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="<p>This function returns a list of the server&#39;s enabled protocols.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of the server'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_enabled_protocols"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Bandwidth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"imap"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's bandwidth usage report<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function queries an account'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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> "pseudo-domain" 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"> <!-- --><<!-- -->unix_timestamp<!-- -->><!-- --> </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="<p>The end date of the report window.</p>
" 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="<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>
" 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">"daily"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"daily"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"hourly"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"5min"</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="<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>
" 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's retention period determines availability of the interval's data.
Use the <code>Bandwidth::get_retention_periods</code> API to determine an interval'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="<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>
" 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"> <!-- --><<!-- -->unix_timestamp<!-- -->><!-- --> </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="<p>The start date of the report window.</p>
" 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"> <!-- --><<!-- -->olson_timezone_name<!-- -->><!-- --> </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="<p>The timezone in which to report the data.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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="<p>grouping=domain</p>
" 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="<p>This function retrieves the retention periods for bandwidth data.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_retention_periods"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Bandwidth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"5min"</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="<p>Security / Known SSH Hosts Management</p>
"><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="<p>This function registers a host in the cPanel account&#39;s <code>/home/user/.ssh/known_hosts</code> file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function registers a host in the cPanel account'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="<p>The hostname or IP address to add.</p>
" 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="<p>The SSH port to use, if the system uses a non-standard SSH port.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"KnownHosts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"hostname.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ=="</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"line"</span>: <span class="token string">"host.example.com ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ=="</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">"ssh-rsa"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"body"</span>: <span class="token string">"AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ=="</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"md5"</span>: <span class="token string">"b6030e39979ed0e724cea3773e014209"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"md5-printable"</span>: <span class="token string">"MD5:b6:03:0e:39:97:9e:d0:e7:24:ce:a3:77:3e:01:42:09"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sha256"</span>: <span class="token string">"44e405bcf4e11ab5b846e58ba0bf6dabd23dcc9e367cae17cb0c91b5b 3b3fc44"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sha256-printable"</span>: <span class="token string">"SHA256:ROQFvPThGrW4RuWLoL9tq9I9zJ42fK4XywyRtbOz/EQ"</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="<p>This function removes a host from the cPanel account&#39;s <code>/home/user/.ssh/known_hosts</code> file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a host from the cPanel account'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="<p>The hostname or IP address of the host to delete.</p>
" 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"> <!-- -->>= 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="<p>The SSH port to use.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"KnownHosts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function updates a host&#39;s entry in the cPanel account&#39;s /home/user/.ssh/known_hosts file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates a host's entry in the cPanel account'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="<p>The host to update.</p>
" 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="<p>The SSH port to use.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"update"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"KnownHosts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"host.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"ssh-rsa AAAAB3NzaC1yc2AEEEEDAQABAAABAQCsj2bNKTBSpIYDEGk9KxsGh3mySTRgMtXL583qmBpzeQ+jqCMRgBqB98u3z++J1sKlXHWfM9dyhSevkMwSbhoR8XIq/U0tCNyokEi/ueaBMCvbcTHhO7FcwzY92WK4Yt0aGROY5qX2UKSeOvuP4D6TPqKF1onSzH9bx9XUf2lEdWT/ia1NEKjunUqu1xOB/StKDHMoX4/OKyIzuS0q/T1zOATthvasJFoPrAjkohTyaDUz2LN5JoH839hViyEG82yB+MjcFV5MU3N1l1QL3cVUCh93xSaua1N85qivl+siMkPGbO5xR/En4iEY6K2XPASUEMaieWVNTRCtJ4S8H+9"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"line"</span>: <span class="token string">"host.example.com ssh-rsa AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"</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">"ssh-rsa"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"body"</span>: <span class="token string">"EEEEB3NzaC1yc2EAAAADAQABAAABAQCsj2bNKTBSpIYDEGk9KxsGh3mySTRgMtXL583qmBpzeQ+jqCMRgBqB98u3z++J1sKlXHWfM9dyhSevkMwSbhoR8XIq/U0tCNyokEi/ueaBMCvbcTHhO7FcwzY92WK4Yt0aGROY5qX2UKSeOvuP4D6TPqKF1onrSzH9\\bx9XUf2lEdWT/ia1NEKjunUqu1xOB/StKDHMoX4/OKyIzuS0q/T1zOATthvasJFoPrAjkohTyaDUz2LN5JoH839hViyEG82yB+MjcFV5MU3N1l1QL3cVUCh93xSaua1N85qivl+siMkPGbO5xR/En4iEY6K2XPASUEMaieWVNTRCtJ4S8H+9"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"md5"</span>: <span class="token string">"b6030e39868ed0e724cea3773e014219"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"md5-printable"</span>: <span class="token string">"MD5:b6:03:0e:39:97:2e:d0:e7:24:ab:c3:77:3d:01:42:09"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sha256"</span>: <span class="token string">"55a405bcf4e11ab5b846e58ba0bf6dabd23dcc9e367cae17cb0c91b5b3b3fc55"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sha256-printable"</span>: <span class="token string">"SHA256:RPLFvPThGrW4RuWLoL9tq9I9zJ42fK3XywyRtbOz/EQ"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether a host's public key exists in the cPanel account'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="<p>The host to query.</p>
" 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="<p>The SSH port to use.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"verify"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"KnownHosts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"The example.com host does not exist in the known_hosts file."</span></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">"new"</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">"host.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ=="</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"line"</span>: <span class="token string">"host.example.com ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ=="</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">"ssh-rsa"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"body"</span>: <span class="token string">"AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ=="</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"md5"</span>: <span class="token string">"b6030e39979ed0e724cea3773e014209"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"md5-printable"</span>: <span class="token string">"MD5:b6:03:0e:39:97:9e:d0:e7:24:ce:a3:77:3e:01:42:09"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sha256"</span>: <span class="token string">"44e405bcf4e11ab5b846e58ba0bf6dabd23dcc9e367cae17cb0c91b5b3b3fc44"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sha256-printable"</span>: <span class="token string">"SHA256:ROQFvPThGrW4RuWLoL9tq9I9zJ42fK4XywyRtbOz/EQ"</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="<p>Security / Login Information</p>
"><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="<p>This function returns the IP address of the user who most recently logged in.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_last_or_current_logged_in_ip"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LastLogin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"192.168.0.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/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's hostname<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves a web server&#39;s hostname.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a web server'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">"host"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"host"</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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_session_information"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Variables"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>Server Information / cPanel Server Information</p>
"><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_information"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ServerInformation"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"apache_php_fpm"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"cpanel-dovecot-solr"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"cpanellogd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"cpdavd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"cphulkd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"cpsrvd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"crond"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"dnsadmin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"exim"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"exim-4.92-1.cp1180.x86_64"</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">"ftpd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"httpd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"2.4.39"</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">"imap"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"ipaliases"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"lmtp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"mailman"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"5.7.25"</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">"named"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"nscd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"pop"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"queueprocd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"rsyslogd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"spamd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"sshd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"service"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"up"</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">"Server Load"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"metric"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"1.73"</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">"CPU Count"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"metric"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"2"</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">"Memory Used"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"device"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"44.12%"</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">"Swap"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"device"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"0.73%"</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">"Disk / (/)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"device"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"26%"</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">"Disk /tmp (/tmp)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"device"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"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">"name"</span>: <span class="token string">"Disk /var/tmp (/var/tmp)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"device"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"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/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's configuration settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>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.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><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">"default_theme"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"email_filter_storage_directory"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"allow_park_subdomain_on_hostname"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"allow_remote_domains"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"allow_unregistered_domains"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"apache_port"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"apache_ssl_port"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"api_shell"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"awstats_browser_update"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"awstats_reverse_dns"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpanel_root_directory"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"database_prefix_required"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"display_cpanel_doclinks"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"dnsadmin_app"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"empty_trash_days"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"enable_file_protect"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"file_upload_maximum_bytes"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"file_upload_must_leave_bytes"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"file_usage"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ftp_server"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"htaccess_check_recurse"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"invite_sub"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ipv6_listen"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"local_nameserver_type"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"logout_redirect_url"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mailbox_storage_format"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mail_server"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"minimum_password_strength"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"minimum_password_strength_mysql"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mysql_host"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mysql_version"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"php_maximum_execution_time"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"php_post_maximum_size"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"php_system_default_version"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"php_upload_maximum_filesize"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"php_loader"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"php_open_basedir_home"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"phpmyadmin_disable_search_info_schema"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"docroots_in_public_html_only"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"require_ssl"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"allow_reset_password"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"allow_reset_password_for_subaccounts"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"disable_analog"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"skip_apache_clients_optimizer"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"disable_awstats"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"skip_mailbox_warnings_check"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"disable_boxtrapper"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"skip_bandwidth_limit_check"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"disable_mailman"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"disable_roundcube"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"disable_spamassassin"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"disable_spambox"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"disable_webalizer"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ssl_default_key_type"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"use_information_schema"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"use_mail_for_mailman_url"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"is_mod_userdir_enabled"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"version"</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&name=allow_remote_domains&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="<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>
" 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'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'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'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's <a href="https://go.cpanel.net/cpaneldocsAPIShell"><em>API Shell</em></a> interface (<em>cPanel >> Home >> Advanced >> 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' 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'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'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's <a href="https://go.cpanel.net/cpaneldocsUserManager"><em>User Manager</em></a> interface (<em>cPanel >> Home >> Preferences >> User Manager</em>).</li>
<li><code>ipv6_listen</code> - Whether the <code>cpsrvd</code> daemon and other cPanel & WHM services listen on IPv6.</li>
<li><code>local_nameserver_type</code> - The DNS nameserver'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'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'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'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 >> Home >> Metrics >> 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'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's Linux® kernel version.</details></li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>If you don't use this parameter, this function returns <strong>all</strong> of the server'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_server_information"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Variables"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"192.0.2.0:80"</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">"192.0.2.0:443"</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">"/usr/local/cpanel"</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">"jupiter"</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">"dnsadmin"</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">"/etc/vfilters"</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">"disabled"</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">"disabled"</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">"powerdns"</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">"</span><a href="https://cpanel.net">https://cpanel.net</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mail_server"</span>: <span class="token string">"dovecot"</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">"maildir"</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">"localhost"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_version"</span>: <span class="token string">"5.7"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"php_loader"</span>: <span class="token string">"ioncube"</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">"ea-php73"</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">"rsa-2048"</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">"3.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>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>The Notifications module for UAPI.</p>
"><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="<p>This function returns the number of server-wide notifications on an account.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_notifications_count"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Notifications"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>Server Information / Password Strength</p>
"><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="<p>This function retrieves an application&#39;s minimum required password strength.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an application'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">"cpaddons"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"createacct"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ftp"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"htaccess"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mysql"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"passwd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"pop"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"postgres"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"sshkey"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"webdisk"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"virtual"</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="<p>The application&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_required_strength"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"PasswdStrength"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>The SSH module for UAPI.</p>
"><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="<p>This function retrieves the server&#39;s SSH port.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the server'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_port"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSH"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>The ServiceProxy module for UAPI.</p>
"><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="<p>This function reports a cPanel account&#39;s
<a href="https://go.cpanel.net/ServiceProxying">service proxying</a>
configuration.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function reports a cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_service_proxy_backends"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ServiceProxy"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service_group"</span>: <span class="token string">"Mail"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a cPanel account'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's web virtual hosts (vhosts) and restarts
the web server.</li>
<li>If the system <strong>cannot</strong> rebuild the cPanel user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"unset_all_service_proxy_backends"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ServiceProxy"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lets you configure a cPanel account'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's web virtual hosts (vhosts) and restarts
the web server.</li>
<li>If the system cannot rebuild the user's vhosts, the API call will still succeed. However,
the function returns a failure warning in the metadata.</li>
<li>To remove an account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hostname or IP address to assign as the server that handles
the account'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">"Mail"</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&service-group-1=Mail&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="<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>
" 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'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&service_group_backend-1=mail.example1.com&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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_service_proxy_backends"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ServiceProxy"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>SSL Certificates / Auto-generated SSL Certificates</p>
"><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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_autossl_excluded_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>This function lists the domains with AutoSSL disabled.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_autossl_excluded_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_autossl_problems"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"problem"</span>: <span class="token string">"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.)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"time"</span>: <span class="token string">"2018-06-07T05:30:09Z"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"is_autossl_check_in_progress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>Enable AutoSSL for this domain.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"remove_autossl_excluded_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_autossl_excluded_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"start_autossl_check"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>SSL Certificates / cPanel Account SSL Management</p>
"><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="<p>This function determines whether the system can automatically redirect domains on a cPanel account to use SSL.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"can_ssl_redirect"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain name.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_ssl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"The SSL host was successfully removed."</span></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="<p>This function checks whether a shared SSL certificate is associated with the account.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"check_shared_cert"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the best-available certificate for the domain. The function also
retrieves the certificate'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain name.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"fetch_best_for_domain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"-----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-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"crt"</span>: <span class="token string">"-----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-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"crt_origin"</span>: <span class="token string">"username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"192.168.0.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"-----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-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_origin"</span>: <span class="token string">"username"</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">"username"</span></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">"ok"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"username"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves all of a certificate'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="<p>The certificate&#39;s human readable name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>The certificate&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"fetch_cert_info"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"-----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-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"certificate"</span>: <span class="token string">"-----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-----"</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">"-----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-----"</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">"192.168.0.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/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="<p>This function retrieves the certificate information for all fully qualified domain names (FQDNs) that the account owns.</p>
" 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="<p>A domain or comma-delimited list of domains for which to retrieve information.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"fetch_certificates_for_fqdns"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"-----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-----"</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">"-----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-----"</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">"example.servername.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"example.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"mail.example.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"www.example.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"www.example.servername.com"</span></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">"Cert for example.servername.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_servername_com_ce52d_6e643_2813308004_119580f9b01960cjones72bc519206bc"</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">"example.servername.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">"Organization"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer_text"</span>: <span class="token string">"stateOrProvinceName\\nTX\\nlocalityName\\nHouston\\ncountryName\\nUS\\ncommonName\\nexample.com\\norganizationName\\ncPanel"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"-----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-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"ce52db786fd2776f69057ed8ee0d8ab267a2f328a66a3afd8\n76017a99d061ec5d24d646f80ec258c696cb742e2bcd2fef920177144d9126a4\n779c1a21ca5589ff06e673556116903493100dfba385a62d11aeec57f47e5b20\nad8d1142fbe93f003fb62403cdcc0012ccd407009ac21639623bc52a5d6d3814\nff9c45a7c246799f0229b4854af2aeddfa755ab13814132424f5b1680f2c357e\n1476af7422bd5863102cfc5982b3ddad7fecdeae5c1cb73789008be9ce2f24fe\n27c9202b3bca6524ba29a30972f14cbf06f0a1b7998c2361ed90221f40829faf\n644adc7b8da6f948d8745ffbe8e5b6f0c8e7ea9ef2bc26413f90666ef1200407\neab7c3b71c6e643"</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">"01e57e4d92"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"signature_algorithm"</span>: <span class="token string">"sha256WithRSAEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">"example.servername.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject_text"</span>: <span class="token string">"stateOrProvinceName\\nTX\\nlocalityName\\nHouston\\ncountryName\\nUS\\ncommonName\\nexample.com\\norganizationName\\ncPanel"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">"dv"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"verify_error"</span>: <span class="token string">"DEPTH_ZERO_SELF_SIGNED_CERT"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>The key&#39;s friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<p>The key&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"find_certificates_for_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span></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">"TestCert"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">"The Example Organization"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer_text"</span>: <span class="token string">"countryName\nUS\ncommonName\u001bxample.com\nlocalityName\nHouston\norganizationName\ncPanel\nstateOrProvinceName\ntx"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</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">"sha256WithRSAEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject_text"</span>: <span class="token string">"countryName\nUS\ncommonName\u001bxample.com\nlocalityName\nHouston\norganizationName\ncPanel\nstateOrProvinceName\ntx"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">"dv"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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"> <!-- --><<!-- -->pem-certificate<!-- -->><!-- --> </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="<p>An SSL certificate.</p>
" 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="<p>The certificate&#39;s contents.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>The certificate'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"> <!-- --><<!-- -->pem-certificate<!-- -->><!-- --> </span></div> <div><div html="<p>The certificate file.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"fetch_key_and_cabundle_for_certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"-----BEGIN CERTIFICATE-----MIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYDVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJvb3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJVUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJUcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyvRLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4MypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/51KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKzdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWlIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9ApybW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY-----END CERTIFICATE-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"crt"</span>: <span class="token string">"-----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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"crt_origin"</span>: <span class="token string">"username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"192.168.0.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"-----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-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_origin"</span>: <span class="token string">"username"</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">"username"</span></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">"ok"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"username"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's certificate signing requests<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>The key&#39;s friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<p>The key&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"find_csrs_for_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</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">"example.com"</span></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">"TestCSR"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_com_a74f7_9dddf_2c5d1615e85db817d6b640f65335fb62"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's CA bundle and hostname<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a certificate'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"> <!-- --><<!-- -->pem-certificate<!-- -->><!-- --> </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="<p>The certificate&#39;s text.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_cabundle"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"VeriSign Trial Secure Server CA - G2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cab"</span>: <span class="token string">"-----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-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function retrieves the most secure domain for a service.</p>
" 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="<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>
" 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="<p>A domain name, cPanel username, or email address.</p>
" 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">"cpanel"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"imap"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"pop3"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"smtp"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_cn_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"hostname"</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">"hostname.example.com"</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's info for dedicated IP<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves information about a certificate that is installed on a domain'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain name.</p>
<p><strong>Note:</strong></p>
<p>The parameter defaults to the account&#39;s main domain.</p>
" 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'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"installed_host"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span></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">"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">"Organization"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer_text"</span>: <span class="token string">"commonName\nexample.com\ncountryName\nUS\nemailAddress\nusername@example.com\norganizationName\nExample\nstateOrProvinceName\nTexas\nlocalityName\nHouston"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</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">"sha256WithRSAEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject_text"</span>: <span class="token string">"commonName\nexample.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">"dv"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"verify_error"</span>: <span class="token string">""</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host"</span>: <span class="token string">"example.com"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a list of the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"installed_hosts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"cPanel"</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">"Sectigo"</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">"example.com"</span></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">"example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">"The Example Organization"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer_text"</span>: <span class="token string">"example.com\ncountryName\nUS\nemailAddress\nusername@example.com\norganizationName\nExample\nstateOrProvinceName\nTexas\nlocalityName\nHouston"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</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">"sha256WithRSAEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject_text"</span>: <span class="token string">"commonName\nexample.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">"dv"</span></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">"-----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-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"docroot"</span>: <span class="token string">"/home/username/public_html"</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">"example.com"</span></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">"www.example.com"</span></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">"192.168.0.1"</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">"example.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_certs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span></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">"TestCert"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">"Organization"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer_text"</span>: <span class="token string">"countryName\nUS\nstateOrProvinceName\nTX\nlocalityName\nHouston\norganizationName\nWebPros International, LLC\ncommonName\nWebPros International, LLC Certification Authority"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</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">"45462cd0d6537b20cf2f3eb8aec07140"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"signature_algorithm"</span>: <span class="token string">"sha256WithRSAEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject_text"</span>: <span class="token string">"commonName\nwww.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">"dv"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_keys"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"TestKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"b116e_473f5_ad6b3bd9517fb157830d0e37a03bc596"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</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="<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>
" 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="<p>The domain name or names.</p>
" 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">"key"</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_ssl_items"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"key"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_csrs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</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">"example.com"</span></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">"TestCSR"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>This function rebuilds the account&#39;s SSL database.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function rebuilds the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"rebuildssldb"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables or disables secure redirects (HTTPS) for the cPanel account'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of the cPanel account'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"toggle_ssl_redirect_for_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"main.example"</span>,</div></li><li><div class="hoverable "><span class="token string">"addon.example"</span>,</div></li><li><div class="hoverable "><span class="token string">"addon.main.example"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>This function sets a user’s preferred SSL/TLS key type.</p>
" 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">"system"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"rsa-2048"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"rsa-4096"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ecdsa-prime256v1"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ecdsa-secp384r1"</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_default_key_type"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="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="<p>SSL Certificates / SNI Email Settings</p>
"><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="<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>
" 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="<p>A pipe-delimited list of the account&#39;s domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A pipe-delimited list of the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"enable_mail_sni"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"Sorry, example.com is not one of the domains on your account."</span></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">"cPanel & WHM always enables mail SNI from now on."</span></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="<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>
" 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'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="<p>A pipe-delimited list of the account&#39;s domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A pipe-delimited list of the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_mail_sni"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"Sorry, example2.com is not one of the domains on your account."</span></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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"is_mail_sni_supported"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"is_sni_supported"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's SNI mail services<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the status of the domain'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The account&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"mail_sni_status"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<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>
" 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'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"rebuild_mail_sni_config"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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="<p>SSL Certificates / SSL Certificate Management</p>
"><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="<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>
" 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'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"> <!-- --><<!-- -->pem-certificate<!-- -->><!-- --> </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="<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>
" 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 'print uri_escape($_);' 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"> <!-- --><<!-- -->pem-certificate<!-- -->><!-- --> </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="<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>
" 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 'print uri_escape($_);' 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain name.</p>
" 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"> <!-- --><<!-- -->pem-private-key<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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 'print uri_escape($_);' 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"install_ssl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"update"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cert_id"</span>: <span class="token string">"example_com_bbe7e_16e2d_1369007999_1d87a0cdb540f5aae607b10e9a1a82fb"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</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">"ssl.example.com"</span></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">"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."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"192.168.0.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token string">"bbe7e_16e2d_df7539f280eb1ecf6c1096190e41ada7"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"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."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"statusmsg"</span>: <span class="token string">"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"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"example"</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">"warning.com"</span></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">"example.com"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>The CSR&#39;s friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The CSR'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="<p>The CSR&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The CSR'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_csr"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</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">"example.com"</span></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">"TestCSR"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a74f7636fa6ac93ee6836a83a995b55deb5019ea36d7ba3dafb00e38d693acd\nb0c81b2ff777d6b433a420fae523f127f352a68bcc8b8f2d6ee7b70395bafab\nd8237ada8164fdddf8376b30375c35d4d4cbcce7d33d08069c17b409176a368\n9f1ebc97c0b08fe6ae44c19a92ac6d68448e7f1d13f3b360affd4222a51b4f3\n5342de99b5a1fb5548e438f2d824664562a448002eed7fce24dedc7dc3e1ed1\n79973d1dae959b33716eeb410d172708954e00632cbf60a0e26419860c8c0bc\n285d6bfe4b479de0dd189772a5dae676bd2a92acccc1369821be8cffddd8a7e\n6ecc061f8a32a9ae0661e4e946ed8e3827b277138d3a76116567cbd129cbd86\n9ef9dddf"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>The private key&#39;s friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The private key'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="<p>The private key&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The private key'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"TestKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</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="<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>
" 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="<p>The certificate&#39;s friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>The certificate&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_cert"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span></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">"TestCert"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">"Organization"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer_text"</span>: <span class="token string">"countryName\nUS\nstateOrProvinceName\nTX\nlocalityName\nHouston\norganizationName\nOrganization\ncommonName\nexample.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</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">"45462cd0d6537b20cf2f3eb8aec07140"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"signature_algorithm"</span>: <span class="token string">"sha256WithRSAEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject_text"</span>: <span class="token string">"commonName\nwww.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">"dv"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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"> <!-- --><<!-- -->ISO-3166-1 (alpha-2)<!-- -->><!-- --> </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="<p>The two-letter country code.</p>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>A comma-separated list of domains for which to generate the certificate.</p>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">""</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="<p>An email address to associate with the certificate.</p>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A friendly name for the new certificate.</p>
<p>This parameter defaults to the domain'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="<p>The key&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<p>The certificate&#39;s city or locality name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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">""</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="<p>The certificate&#39;s organizational unit or department name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>The certificate&#39;s Organization Name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>The two-letter state or locality abbreviation.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"generate_cert"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span></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">"TestCert"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">"Organization"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</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">"01e57e4d92"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"signature_algorithm"</span>: <span class="token string">"sha256WithRSAEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">"-----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"</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">"Certificate generated"</span></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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A friendly name for the new key.</p>
<p>This parameter defaults to the key'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="<p>The key&#39;s modulus size.</p>
<p><strong>Note:</strong></p>
<p>Use the <code>keytype</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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">"system"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"rsa-2048"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"rsa-4096"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ecdsa-prime256v1"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ecdsa-secp384r1"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key's type.</p>
<ul>
<li><code>system</code> — The system'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 ("P-256").</li>
<li><code>ecdsa-secp384r1</code> — ECDSA secp384r1 ("P-384").</li>
</ul>
<p>This parameter defaults to the user'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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"generate_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"TestKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</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">"-----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-----"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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's <code>ssl</code> directory.
You can generate a key with UAPI'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"> <!-- --><<!-- -->ISO-3166-1 (alpha-2)<!-- -->><!-- --> </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="<p>The two-letter country code.</p>
" 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="<p>A comma-separated list of the domains for which to generate the certificate.</p>
" 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"> <!-- --><<!-- -->email<!-- -->><!-- --> </span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">""</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="<p>An email address to associate with the certificate.</p>
" 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="<p>A friendly name for the new certificate.</p>
<p>This parameter defaults to the domain name for which you generated the
certificate.</p>
" 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="<p>The key&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<p>The certificate&#39;s city or locality name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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">""</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="<p>The certificate&#39;s organizational unit or department name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>The certificate&#39;s organization.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>The certificate&#39;s state or locality name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"generate_csr"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</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">"example.com"</span></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">"TestCSR"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">"-----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-----"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <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">"Certificate Signing Request generated!"</span></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's friendly name<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes a certificate'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="<p>The certificate&#39;s friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>The certificate&#39;s new friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_cert_friendly_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's friendly name<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes a certificate signing request'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="<p>The CSR&#39;s friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The CSR'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The CSR's ID.</p>
<p><strong>Note:</strong></p>
<p>To retrieve a CSR'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="<p>The CSR&#39;s new friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The CSR'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_csr_friendly_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's friendly name<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes a key'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="<p>The key&#39;s friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<p>The key&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<p>The key&#39;s new friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_key_friendly_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The primary SSL website&#39;s servername.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The primary SSL website'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_primary_ssl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The certificate&#39;s friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>The certificate&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"show_cert"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"-----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-----"</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">"example.com"</span></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">"TestCert"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"countryName"</span>: <span class="token string">"US"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emailAddress"</span>: <span class="token string">"username@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"localityName"</span>: <span class="token string">"Houston"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organizationName"</span>: <span class="token string">"Organization"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stateOrProvinceName"</span>: <span class="token string">"Texas"</span></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">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</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">"sha256WithRSAEncryption"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"countryName"</span>: <span class="token string">"US"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emailAddress"</span>: <span class="token string">"username@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"localityName"</span>: <span class="token string">"Houston"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organizationName"</span>: <span class="token string">"Organization"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stateOrProvinceName"</span>: <span class="token string">"Texas"</span></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">"dv"</span></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">"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"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"show_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"TestKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"-----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-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</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">"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"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>The CSR&#39;s friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The CSR'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="<p>The CSR&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The CSR'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"show_csr"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"-----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-----"</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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"countryName"</span>: <span class="token string">"US"</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">"example.com"</span></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">"username@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">"TestCSR"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"localityName"</span>: <span class="token string">"Houston"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a74f7636fa6ac93ee6836a83a995b55deb5019ea36d7ba3dafb00e38d693acdb0c81b2ff777d6b433a420fae523f127f352a68bcc8b8f2d6ee7b70395bafabd8237ada8164fdddf8376b30375c35d4d4cbcce7d33d08069c17b409176a3689f1ebc97c0b08fe6ae44c19a92ac6d68448e7f1d13f3b360affd4222a51b4f35342de99b5a1fb5548e438f2d824664562a448002eed7fce24dedc7dc3e1ed179973d1dae959b33716eeb410d172708954e00632cbf60a0e26419860c8c0bc285d6bfe4b479de0dd189772a5dae676bd2a92acccc1369821be8cffddd8a7e6ecc061f8a32a9ae0661e4e946ed8e3827b277138d3a76116567cbd129cbd869ef9dddf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organizationName"</span>: <span class="token string">"Organization"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organizationalUnitName"</span>: <span class="token string">"Department"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stateOrProvinceName"</span>: <span class="token string">"Texas"</span></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">"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"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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"> <!-- --><<!-- -->pem-certificate<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">crt="-----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-----"</span></div><div><div html="<p>The certificate&#39;s contents.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>The certificate&#39;s friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>The certificate&#39;s contents.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>The certificate'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"> <!-- --><<!-- -->pem-certificate<!-- -->><!-- --> </span></div> <div><div html="<p>The certificate file.</p>
" 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="<p>The certificate&#39;s friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"upload_cert"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span></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">"TestCert"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041"</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">"VeriSign Trial Secure Server CA - G2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">"VeriSign, Inc."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</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">"sha256WithRSAEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">"dv"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>The key&#39;s friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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"> <!-- --><<!-- -->pem-private-key<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key="-----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-----"</span></div><div><div html="<p>The key&#39;s contents.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<p>The certificate&#39;s contents.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>The certificate'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"> <!-- --><<!-- -->pem-private-key<!-- -->><!-- --> </span></div> <div><div html="<p>The key&#39;s contents.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<p>The key&#39;s friendly name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"upload_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"TestKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"bbe7e_16e2d_df7539f280eb1ecf6c1096190e41ada7"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"</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="<p>SSL Certificates / Verify Domain Ownership</p>
"><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="<p>This function checks whether the account&#39;s domains can pass Domain Control Validation (DCV) via a DNS request.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the account'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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=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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"check_domains_via_dns"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DCV"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"_dcv-test-record=wsWRlG9IsG7KNnLdIsx9Oz2oTw8m5q0imRR9L6LnDBz14sZelvDHqrJyJc6LA0DY"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failure_reason"</span>: <span class="token string">"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."</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">"_dcv-test-record=wsWRlG9IsG7KNnLdIsx9Oz2oTw8m5q0imRR9L6LnDBz14sZelvDHqrJyJc6LA0DY"</span></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">"example.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>This function checks whether the account&#39;s domains can pass Domain Control Validation (DCV) via an HTTP request.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the account'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">"A&dcv_file_allowed_characters=B&dcv_file_allowed_characters=C&dcv_file_allowed_characters=D&dcv_file_allowed_characters=E&dcv_file_allowed_characters=F&dcv_file_allowed_characters=G&dcv_file_allowed_characters=H&dcv_file_allowed_characters=I&dcv_file_allowed_characters=J&dcv_file_allowed_characters=K&dcv_file_allowed_characters=L&dcv_file_allowed_characters=M&dcv_file_allowed_characters=N&dcv_file_allowed_characters=O&dcv_file_allowed_characters=P&dcv_file_allowed_characters=Q&dcv_file_allowed_characters=R&dcv_file_allowed_characters=S&dcv_file_allowed_characters=T&dcv_file_allowed_characters=U&dcv_file_allowed_characters=V&dcv_file_allowed_characters=W&dcv_file_allowed_characters=X&dcv_file_allowed_characters=Y&dcv_file_allowed_characters=Z&dcv_file_allowed_characters=0&dcv_file_allowed_characters=1&dcv_file_allowed_characters=2&dcv_file_allowed_characters=3&dcv_file_allowed_characters=4&dcv_file_allowed_characters=5&dcv_file_allowed_characters=6&dcv_file_allowed_characters=7&dcv_file_allowed_characters=8&dcv_file_allowed_characters=9"</span></div> <div><div html="<p>An array of characters that the certificate provider allows in the DCV check file&#39;s filename.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An array of characters that the certificate provider allows in the DCV check file'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">""</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="<p>The DCV check file extension that the certificate provider requires.</p>
" 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"> <!-- -->>= 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="<p>The number of characters that the certificate provider allows in the DCV check file&#39;s filename.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of characters that the certificate provider allows in the DCV check file'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">".well-known/pki-validation"</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="<p>The DCV check file&#39;s file path, relative to the domain&#39;s document <code>root</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The DCV check file's file path, relative to the domain'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"> <!-- -->>= 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="<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>
" 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'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'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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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&domain-2=example2.com&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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"check_domains_via_http"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DCV"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"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."</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">"<!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"</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">"HTTP/1.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Moved Permanently"</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">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"</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">"</span></div></li></ul><span class="token punctuation">}</span></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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function indicates whether the account's domains can pass a Domain Control
Validation (DCV) check.</p>
<p><strong>Warning:</strong></p>
<p>We deprecated this function. Use UAPI'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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"ensure_domains_can_pass_dcv"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"DCV"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"The domain resolves to Mars. Beep beep beep."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>Statistics / Domain Statistics</p>
"><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="<p>This function returns entries from a domain&#39;s error log.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns entries from a domain'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain for which to return error log entries.</p>
" 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">"error"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"suexec"</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="<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>
" 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="<p>The number of lines to retrieve from the error log.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_site_errors"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Stats"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"[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"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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's <a href="https://go.cpanel.net/whmdocsFeatureManager"><em>Feature Manager</em></a>
interface (<em>WHM >> Home >> Packages >> 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="<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>
" 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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_bandwidth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Stats"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</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">"imap"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>This function displays the Analog statistics for the domains on a cPanel account.</p>
" 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">"webalizer"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"analog"</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="<p>The statistics engine.</p>
<ul>
<li><code>webalizer</code></li>
<li><code>analog</code></li>
</ul>
" 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">"http"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"http"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ftp"</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="<p>The web traffic type.</p>
<ul>
<li><code>http</code></li>
<li><code>ftp</code></li>
</ul>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_sites"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Stats"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"/tmp/user/webalizer/index.html"</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="<p>This function returns a domain&#39;s Analog statistics.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a domain'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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain from which to retrieve statistics.</p>
" 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">"analog"</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="<p>The statistics engine. <code>analog</code> is the only possible value.</p>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_stats_by_domain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Stats"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"tmp/cptest/analog/8.html.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>Statistics / Weblog Settings</p>
"><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' configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_configuration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"StatsManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"awstats"</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">"analog"</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">"webalizer"</span></div></li></ul><span class="token punctuation">}</span></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">"domain.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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">"analog"</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">"awstats"</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">"webalizer"</span></div></li></ul><span class="token punctuation">}</span></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's weblog analyzers configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>List of domains and what web log analyzers to change.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"awstats"</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">"analog"</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">"webalizer"</span></div></li></ul><span class="token punctuation">}</span></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">"domain.com"</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">"save_configuration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"StatsManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"awstats"</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">"analog"</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">"webalizer"</span></div></li></ul><span class="token punctuation">}</span></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">"user"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>The EA4 module for UAPI.</p>
"><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="<p>This function retrieves a list of EasyApache 4 (EA4) configuration recommendations.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_recommendations"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"EA4"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"PHP DSO runs as the user [asis,nobody] by default. In a shared hosting environment, this is a security issue."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"level"</span>: <span class="token string">"danger"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"PHP DSO"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"on"</span>: <span class="token string">"add"</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">"ea-apache24-mod_ruid2"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-apache24-mod_mpm_itk"</span></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">"success"</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">"We strongly recommend that you install one of the following packages unless this is a single-user system:"</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">"warning"</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">"If you use suPHP, you will add some security, but may experience performance issues on your server."</span></div></li></ul><span class="token punctuation">}</span></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">"</span><a href="https://www.example.com">https://www.example.com</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>Web Server Configuration / EasyApache Settings</p>
"><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="<p>PHP recommendations</p>
"><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="<p>This function returns a list of recommended PHP versions.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_php_recommendations"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"EA4"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"php80"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>Web Server Management / Application Manager</p>
"><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="<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>
" 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="<p>Whether to clear the application’s environment variables.</p>
" 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">"production"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"development"</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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The application’s new domain. If you do not use this parameter, the function does not change the application’s domain.</p>
" 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="<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>
" 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&envvar_name=TINMAN&envvar_name=LION</span></div><div><div html="<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>
" 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&envvar_value=heart&envvar_value=courage</span></div><div><div html="<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>
" 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="<p>The application’s current name.</p>
" 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="<p>The application’s new name. If you do not use this parameter, the function does not change the application&#39;s name.</p>
" 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'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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The application’s new filepath. If you do not use this parameter, the function does not change the application’s filepath.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"/littledog"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deployment_mode"</span>: <span class="token string">"production"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"toto.com"</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">"courage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"SCARECROW"</span>: <span class="token string">"brain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"TINMAN"</span>: <span class="token string">"heart"</span></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">"Little Dog"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"/home/dorothy/littledog"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><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="<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>
" 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="<p>The application to disable.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"PassengerApps"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The Passenger application to enable on the account.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"enable_application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"PassengerApps"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_applications"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"PassengerApps"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/app1-uri"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deployment_mode"</span>: <span class="token string">"production"</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">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"npm"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pip"</span>: <span class="token string">"cd /home/user/app1-dir && pip install --user -r requirements.txt"</span></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">"example.com"</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">"Name of Application 1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"/home/user/app1-dir"</span></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">"/app2-uri"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deployment_mode"</span>: <span class="token string">"development"</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">"cd /home/user/app2-dir && BUNDLE_PATH=~/.gem /path/to/ruby/version/package/bundler install"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"npm"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pip"</span>: <span class="token string">"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">"domain"</span>: <span class="token string">"example.com"</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">"Name of Application 2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"/home/user/app2-dir"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The application’s filepath.</p>
" 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">"gem"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"npm"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"pip"</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"ensure_deps"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"PassengerApps"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/sse/UserTasks/00000000_5c6c8b18228a35/ensure_deps.log"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"task_id"</span>: <span class="token string">"00000000/5c76ec5566332c"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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"> <!-- --><<!-- -->url-path<!-- -->><!-- --> </span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"/"</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="<p>The application’s base URI.</p>
" 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">"production"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"production"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"development"</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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain for which to register the application.</p>
" 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="<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>
" 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"> <!-- --><= 256 characters<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">envvar_name=SHOES&envvar_name=TINMAN</span></div><div><div html="<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>
" 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'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.</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"> <!-- --><= 1024 characters<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">envvar_value=ruby&envvar_value=heart</span></div><div><div html="<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>
" 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="<p>The application’s name.</p>
" 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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The application’s filepath relative to the user’s home directory.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"register_application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"PassengerApps"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/ruby"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deployment_mode"</span>: <span class="token string">"production"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"dorothy.com"</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">"ruby"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"TINMAN"</span>: <span class="token string">"heart"</span></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">"Name of Application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"/home/dorothy/slippers"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>The application to unregister.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"unregister_application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"PassengerApps"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>The ModSecurity module for UAPI.</p>
"><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables ModSecurity™ on a cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_all_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ModSecurity"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"dallas.com"</span></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">"dallas.example.com"</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">"dallas.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</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">"arkansas.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"kansas.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"nevada.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"newmexico.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"texas.com"</span></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">"example.com"</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">"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"main"</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">"galveston.com"</span></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">"galveston.example.com"</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">"galveston.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</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">"houston.com"</span></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">"houston.example.com"</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">"houston.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</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">"neworleans.com"</span></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">"neworleans.example.com"</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">"neworleans.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</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">"sanantonio.com"</span></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">"sanantonio.example.com"</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">"sanantonio.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ModSecurity"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"dallas.com"</span></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">"dallas.example.com"</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">"dallas.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</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">"arkansas.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"kansas.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"nevada.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"newmexico.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"texas.com"</span></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">"example.com"</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">"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"main"</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">"galveston.com"</span></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">"galveston.example.com"</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">"galveston.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables ModSecurity™ on a cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"enable_all_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ModSecurity"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"dallas.com"</span></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">"dallas.example.com"</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">"dallas.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</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">"arkansas.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"kansas.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"nevada.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"newmexico.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"texas.com"</span></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">"example.com"</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">"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"main"</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">"galveston.com"</span></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">"galveston.example.com"</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">"galveston.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</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">"houston.com"</span></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">"houston.example.com"</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">"houston.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</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">"neworleans.com"</span></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">"neworleans.example.com"</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">"neworleans.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</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">"sanantonio.com"</span></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">"sanantonio.example.com"</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">"sanantonio.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"enable_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ModSecurity"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"dallas.com"</span></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">"dallas.example.com"</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">"dallas.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</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">"arkansas.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"kansas.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"nevada.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"newmexico.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"texas.com"</span></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">"example.com"</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">"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"main"</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">"galveston.com"</span></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">"galveston.example.com"</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">"galveston.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"has_modsecurity_installed"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ModSecurity"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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' status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns ModSecurity's™ status for a cPanel account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"ModSecurity"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"dallas.com"</span></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">"dallas.example.com"</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">"dallas.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</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">"arkansas.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"kansas.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"nevada.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"newmexico.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"texas.com"</span></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">"example.com"</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">"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"main"</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">"galveston.com"</span></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">"galveston.example.com"</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">"galveston.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</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">"houston.com"</span></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">"houston.example.com"</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">"houston.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</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">"neworleans.com"</span></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">"neworleans.example.com"</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">"neworleans.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</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">"sanantonio.com"</span></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">"sanantonio.example.com"</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">"sanantonio.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"sub"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>The NginxCaching module for UAPI.</p>
"><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's NGINX cache<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"enable_cache"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"NginxCaching"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function clears the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"clear_cache"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"NginxCaching"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's NGINX cache configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function resets the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"reset_cache_config"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"NginxCaching"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's NGINX cache<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"disable_cache"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"NginxCaching"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>Web Server Management / PHP Settings</p>
"><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's handler<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a PHP version'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">"home"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"vhost"</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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"php_get_domain_handler"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LangPHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"cgi"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return domains that inherit the system's default PHP version.</p>
<ul>
<li><code>1</code> - Return domains that inherit the system's default PHP version.</li>
<li><code>0</code> - Do <strong>not</strong> return domains that inherit the system'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"php_get_impacted_domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LangPHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the system'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"php_get_installed_versions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LangPHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"ea-php72"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's php.ini content<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the contents of a virtual host'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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"php_ini_get_user_content"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LangPHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"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"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"php_get_system_default_version"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LangPHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"ea-php73"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a virtual host's basic PHP directives. The Basic Mode section of cPanel's <a href="https://go.cpanel.net/cPanelMultiPHPINI">MultiPHP INI Editor</a> interface (Home >> Software >> 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">"home"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"vhost"</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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"php_ini_get_user_basic_directives"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LangPHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"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."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"allow_url_fopen"</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">"PHP_INI_SYSTEM"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"integer"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"On"</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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the <code>php.ini</code> file paths for the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"php_ini_get_user_paths"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LangPHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"allthethings"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">"/home/allthethings/public_html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">"/home/allthethings/"</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">"php.ini"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"vhost"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"ea-php72"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vhost"</span>: <span class="token string">"clearly.com"</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="<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>
" 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's
<a href="https://go.cpanel.net/whmdocsMultiPHPINIEditor"><em>MultiPHP INI Editor</em></a> interface (<em>WHM >> Home >> Software >> 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&directive-2=upload_max_filesize%3A4M&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="<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>
" 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'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><directive>:<value></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">"home"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"vhost"</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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"php_ini_set_user_basic_directives"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LangPHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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">"/home/allthethings/public_html/php.ini"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phpversion"</span>: <span class="token string">"ea-php55"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"vhost"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vhost"</span>: <span class="token string">"clearly.com"</span></div></li></ul><span class="token punctuation">}</span></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's php.ini content<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes the contents of a virtual host'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="<p>The content of the <code>php.ini</code> file to change.</p>
" 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">"host"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"vhost"</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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"php_ini_set_user_content"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LangPHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's PHP version<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets a virtual host'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="<p>The PHP version of a virtual host.</p>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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&vhost-2=example2.com&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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The virtual host'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"php_set_vhost_versions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LangPHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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's PHP version<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" 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="<p>The PHP Virtual Hostname.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"php_get_vhost_versions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LangPHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"blee"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"account_owner"</span>: <span class="token string">"blee"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">"/home/blee/public_html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">"/home/blee"</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">"blee.com"</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">"ea-php72"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vhost"</span>: <span class="token string">"blee.com"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>Website Configuration / Handler Management</p>
"><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="<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>
" 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="<p>The file extension.</p>
" 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="<p>The Apache MIME handler.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_handler"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The file extension.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_handler"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's MIME handlers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all of Apache'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">"system"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"user"</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="<p>Whether to retrieve system or user handlers.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_handlers"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">".foo"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"handler"</span>: <span class="token string">"text-foo"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"origin"</span>: <span class="token string">"user"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </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="<p>The domain for which to retrieve redirector information.</p>
" 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"> <!-- --><<!-- -->url<!-- -->><!-- --> </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="<p>The URL for which to retrieve redirector information.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"redirect_info"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"</span><a href="http://redirect.example.com">http://redirect.example.com</a><span class="token string">"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>Website Configuration / Logs</p>
"><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="<p>Delete a specific log archive file from the authenticated user&#39;s <code>~/logs</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Delete a specific log archive file from the authenticated user'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The log archive filename to delete. Requirements:</p>
<ul>
<li>Must reside in the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_archive"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LogManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's log archival settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the account&#39;s log archival settings.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the account'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"get_settings"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LogManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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's archive files list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a list of the user&#39;s archive files.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of the user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_archives"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LogManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"domain.com-May-2019.gz"</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">"/home/user/logs/domain.com-May-2019.gz"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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's log archive settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function saves the account'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="<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>
" 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's value in the user'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'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to remove the previous month'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's value in the user's <code>~/.cpanel-logs</code> file.</li>
<li>If this file doesn't exist, this parameter defaults to the <code>default_remove-old-archive-logs</code> key'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"> <!-- -->>= -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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"set_settings"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"LogManager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>Website Configuration / Mime Type Management</p>
"><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="<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>
" 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="<p>The file extension.</p>
" 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"> <!-- --><<!-- -->MIME<!-- -->><!-- --> </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="<p>The MIME type.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"add_mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<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>
" 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="<p>The MIME type.</p>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"delete_mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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's MIME types<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all of Apache'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">"system"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"user"</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="<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>
" 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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Mime"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">".foo"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"origin"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"application/foo"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<p>Website Configuration / Site Information</p>
"><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="<p>This function retrieves the installation status and detailed information of the WordPress site for cPanel user&#39;s primary domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the installation status and detailed information of the WordPress site for cPanel user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"retrieve"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressSite"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"in progress"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</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="<p>Website Configuration / Site Installation</p>
"><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="<p>This function installs a WordPress site for cPanel user&#39;s primary domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function installs a WordPress site for cPanel user'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"create"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WordPressSite"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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="<p>Website Configuration / Site Publisher Management</p>
"><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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists available templates for cPanel'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's templates.</li>
<li>If you call this function as a reseller, the function lists the <code>root</code> user's templates <strong>and</strong> the reseller's templates.</li>
<li>If you call this function as a cPanel user, the function's output depends on the account's owner:<ul>
<li>If the <code>root</code> user owns the account, the function only lists the <code>root</code> user's templates.</li>
<li>If a reseller owns the account, the function lists the <code>root</code> user's templates <strong>and</strong> that reseller's templates.</li>
</ul>
</li>
</ul>
<p><strong>Note:</strong></p>
<p> The template directory'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's templates.</li>
<li><code>/home/username/var/cpanel/reseller/site_templates/</code> — A reseller's templates, where <code>username</code> represents the reseller'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_site_templates"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SiteTemplates"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"fullName"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">"Full Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"placeholder"</span>: <span class="token string">"Your Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"text"</span></div></li></ul><span class="token punctuation">}</span></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">"2020-06-30"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Single page 'About Me' site"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"about_me"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"About Me"</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">"/preview.png"</span></div></li></ul><span class="token punctuation">}</span></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">"/usr/local/cpanel/3rdparty/share/site_templates"</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">"about_me"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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="<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>
" 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's contents in the <code>/site_publisher/backups/</code> directory within the user'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'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's templates.</li>
<li><code>/home/username/var/cpanel/reseller/site_templates/</code> — A reseller's templates, where <code>username</code> represents the reseller'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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The template's variables and values.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Use each variable'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'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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory that contains the template's source directory.</p>
<ul>
<li><code>/var/cpanel/customizations/site_templates/</code> — The <code>root</code> user's templates.</li>
<li><code>/home/username/var/cpanel/reseller/site_templates/</code> — A reseller's templates, where <code>username</code> represents the reseller'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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<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>
" 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's templates.</li>
<li><code>/home/username/var/cpanel/reseller/site_templates/</code> — A reseller's templates, where <code>username</code> represents the reseller'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'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"> <!-- --><<!-- -->path<!-- -->><!-- --> </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="<p>The directory that will contain the Site Publisher website.</p>
" 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="<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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The template's directory'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"publish"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SiteTemplates"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><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' information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<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>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists information for the cPanel account'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'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="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="<p>The version of the API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the method called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the module called.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-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="<p>A server running cPanel.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-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">"list_user_settings"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SiteTemplates"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span 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">"/home/example/public_html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">"/home/example"</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">"www.example.com"</span></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">"/usr/local/cpanel/3rdparty/share/site_templates/"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"template"</span>: <span class="token string">"mytemplate"</span></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">"main"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <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 "/etc/vfilters/example.com"\\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['