Viewing File: /usr/local/cpanel/whostmgr/docroot/openapi/whm.openapi.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf8" />
<title>WHM API</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*/
.NyAuz{margin:0 0 3px 0;display:inline-block;}/*!sc*/
data-styled.g25[id="sc-eUlrpB"]{content:"NyAuz,"}/*!sc*/
.dSHOzv{font-size:0.9em;margin-right:10px;color:black;font-family:Montserrat Medium,sans-serif;}/*!sc*/
data-styled.g26[id="sc-geXuza"]{content:"dSHOzv,"}/*!sc*/
.dhcDOu{display:inline-block;margin-right:10px;margin-bottom:5px;font-size:0.8em;cursor:pointer;border:1px solid black;padding:2px 10px;line-height:1.5em;outline:none;color:white;background-color:black;}/*!sc*/
.dhcDOu:focus{box-shadow:0 0 0 1px black;}/*!sc*/
.dhcDOu:focus{box-shadow:none;background-color:#000;}/*!sc*/
.kXIkjx{display:inline-block;margin-right:10px;margin-bottom:5px;font-size:0.8em;cursor:pointer;border:1px solid black;padding:2px 10px;line-height:1.5em;outline:none;color:black;background-color:white;}/*!sc*/
.kXIkjx:focus{box-shadow:0 0 0 1px black;}/*!sc*/
data-styled.g27[id="sc-hJRrWL"]{content:"dhcDOu,kXIkjx,"}/*!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*/
.bweot{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*/
data-styled.g38[id="sc-kZrBCu"]{content:"JXohG,bweot,"}/*!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*/
.kNKbJU{color:#b3b3b3;word-break:break-word;}/*!sc*/
data-styled.g61[id="sc-gcfzXs"]{content:"kNKbJU,"}/*!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*/
.jmhcYd{color:#808080;}/*!sc*/
data-styled.g63[id="sc-iRLAEC"]{content:"jmhcYd,"}/*!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/whm-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/Account-Restoration" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Account Restoration" class="sc-enMaOJ bBONey">Account Restoration</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Restore-Account" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Restore Account" class="sc-enMaOJ bBONey">Restore Account</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/Restore-Account/operation/restore_queue_add_task" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 user account from backup</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Restore-Account/operation/restoreaccount" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 account backup</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Restore-Account/operation/verify_new_username_for_restore" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 username during restoration</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Restore-Queue-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Restore Queue Management" class="sc-enMaOJ bBONey">Restore Queue 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/Restore-Queue-Management/operation/restore_queue_activate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 restoration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Restore-Queue-Management/operation/restore_queue_clear_all_completed_tasks" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 all completed restoration tasks</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Restore-Queue-Management/operation/restore_queue_clear_all_failed_tasks" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 all failed restoration tasks</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Restore-Queue-Management/operation/restore_queue_clear_all_pending_tasks" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 all pending restoration tasks</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Restore-Queue-Management/operation/restore_queue_clear_all_tasks" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 all restoration tasks</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Restore-Queue-Management/operation/restore_queue_clear_completed_task" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 completed restoration task</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Restore-Queue-Management/operation/restore_queue_clear_pending_task" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 pending restoration task</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Restore-Queue-Reporting" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Restore Queue Reporting" class="sc-enMaOJ bBONey">Restore Queue Reporting</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/Restore-Queue-Reporting/operation/restore_queue_is_active" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 restoration queue is active</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Restore-Queue-Reporting/operation/restore_queue_list_active" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return active restoration tasks list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Restore-Queue-Reporting/operation/restore_queue_list_completed" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return completed restoration tasks list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Restore-Queue-Reporting/operation/restore_queue_state" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return restoration tasks list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Restore-Queue-Reporting/operation/restore_queue_list_pending" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return pending restoration tasks list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Restore-Queue-Reporting/operation/restore_modules_summary" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 modules list</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Accounts" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Accounts" class="sc-enMaOJ bBONey">Accounts</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Account-Creation" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Account Creation" class="sc-enMaOJ bBONey">Account Creation</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-Creation/operation/verify_new_username" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 new cPanel account username</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Creation/operation/get_current_users_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 cPanel accounts total number</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Creation/operation/get_maximum_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 maximum accounts for license</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Creation/operation/createacct" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 account</span></label></li></ul></li><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/list_account_enhancements" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 Enhancements</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Enhancements/operation/create_account_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">Create Account Enhancement</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Enhancements/operation/delete_account_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">Remove an Account Enhancement</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Enhancements/operation/modify_account_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">Update Account Enhancement</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Enhancements/operation/unassign_account_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">Unassign Account Enhancement</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Enhancements/operation/assign_account_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">Assign Account Enhancement</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/untrack_acct_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">Remove UID or GID from tracked list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/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">Return data from NVData file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/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 data to NVData file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/operation/removeacct" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 cPanel account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/operation/get_homedir_roots" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return home directories list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/operation/has_digest_auth" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Digest Authentication</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/operation/set_digest_auth" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Digest Authentication</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/operation/has_mycnf_for_cpuser" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Configuration file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/operation/listaccts" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/operation/modifyacct" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/operation/changepackage" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 user hosting plan</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/operation/get_upgrade_opportunities" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 upgrade opportunities</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/operation/myprivs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 system privileges</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/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">Return root and cPanel accounts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/operation/massmodifyacct" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 multiple cPanel accounts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Management/operation/accountsummary" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 summary</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Bandwidth-and-Disk-Quotas" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Bandwidth and Disk Quotas" class="sc-enMaOJ bBONey">Bandwidth and 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/Bandwidth-and-Disk-Quotas/operation/limitbw" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 bandwidth quota</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Bandwidth-and-Disk-Quotas/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 all cPanel accounts disk usage</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Bandwidth-and-Disk-Quotas/operation/quota_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">Validate cPanel account quotas</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Bandwidth-and-Disk-Quotas/operation/showbw" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 bandwidth information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Bandwidth-and-Disk-Quotas/operation/editquota" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 disk quota</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/convert_addon_fetch_conversion_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 additional domain conversion details</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Information/operation/convert_addon_fetch_domain_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 additional domain data</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Information/operation/convert_addon_get_conversion_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 conversion status for additional domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Information/operation/convert_addon_list_addon_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 current user's additional domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Information/operation/convert_addon_list_conversions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return additional domains conversion queue</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Information/operation/convert_addon_initiate_conversion" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 additional domain conversion</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Information/operation/domainuserdata" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 user information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Information/operation/get_domain_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 all domains information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Information/operation/getdomainowner" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 owner</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Passwords" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Passwords" class="sc-enMaOJ bBONey">Passwords</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/Passwords/operation/getminimumpasswordstrengths" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 password strength</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Passwords/operation/setminimumpasswordstrengths" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 password strength</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Passwords/operation/get_password_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 password strength</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Passwords/operation/forcepasswordchange" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 forced password update</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Passwords/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 cPanel account password</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Styles" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Styles" class="sc-enMaOJ bBONey">Styles</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/Styles/operation/get_users_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 cPanel account theme's app keys and URLs</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Suspensions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Suspensions" class="sc-enMaOJ bBONey">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/Suspensions/operation/suspendacct" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 cPanel account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Suspensions/operation/unsuspendacct" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 cPanel account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Suspensions/operation/listlockedaccounts" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return suspended cPanel accounts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Suspensions/operation/listsuspended" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return suspended cPanel accounts and information</span></label></li></ul></li></ul></li><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-Execution" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="API Execution" class="sc-enMaOJ bBONey">API Execution</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-Execution/operation/cors_proxy_get" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 CORS HTTP requests</span></label></li><li tabindex="0" depth="2" data-item-id="tag/API-Execution/operation/uapi_cpanel" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 UAPI function through WHM API</span></label></li><li tabindex="0" depth="2" data-item-id="tag/API-Execution/operation/batch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 WHM API 1 functions</span></label></li><li tabindex="0" depth="2" data-item-id="tag/API-Execution/operation/cpanel" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 cPanel API or UAPI function</span></label></li><li tabindex="0" depth="2" data-item-id="tag/API-Execution/operation/execute_remote_whmapi1_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">Run remote WHM API 1 function</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/API-Statistics" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="API Statistics" class="sc-enMaOJ bBONey">API 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/API-Statistics/operation/get_api_calls" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return deprecated cPanel API 1 functions by date</span></label></li><li tabindex="0" depth="2" data-item-id="tag/API-Statistics/operation/get_api_pages" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return deprecated cPanel API 1 functions </span></label></li></ul></li><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/api_token_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 WHM API token</span></label></li><li tabindex="0" depth="2" data-item-id="tag/API-Token-Management/operation/api_token_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">Disable WHM API token</span></label></li><li tabindex="0" depth="2" data-item-id="tag/API-Token-Management/operation/api_token_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 WHM API tokens</span></label></li><li tabindex="0" depth="2" data-item-id="tag/API-Token-Management/operation/api_token_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 WHM API token's settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/API-Token-Management/operation/api_token_get_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">Look up API token details</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Applications" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Applications" class="sc-enMaOJ bBONey">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/Applications/operation/applist" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return WHM API 1 functions list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Applications/operation/get_appconfig_application_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 registered applications</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Session" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Session" class="sc-enMaOJ bBONey">Session</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/Session/operation/create_user_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">Create a temporary user session</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/Authentication-Providers" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Authentication Providers" class="sc-enMaOJ bBONey">Authentication Providers</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/Authentication-Providers/operation/unlink_user_authn_provider" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 cPanel account from authentication provider</span></label></li></ul></li><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/disable_failing_authentication_providers" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 identity provider modules that fail to load</span></label></li><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/get_available_authentication_providers" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 identity providers</span></label></li><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/enable_authentication_provider" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 identity provider</span></label></li><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/get_provider_client_configurations" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return identity provider client configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/get_provider_configuration_fields" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return identity provider configuration fields</span></label></li><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/get_provider_display_configurations" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return identity provider login interface appearance</span></label></li><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/set_provider_client_configurations" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 identity provider client configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/set_provider_display_configurations" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 identity provider login interface appearance</span></label></li><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/disable_authentication_provider" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 identity provider</span></label></li><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/get_users_authn_linked_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 accounts linked to identity providers</span></label></li><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/link_user_authn_provider" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 identity provider to cPanel account</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Login-URL" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Login URL" class="sc-enMaOJ bBONey">Login URL</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-URL/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 cPanel Store or cPanel Market login URL</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/SSH-Keys-and-Connections" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="SSH Keys and Connections" class="sc-enMaOJ bBONey">SSH Keys and Connections</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-Keys-and-Connections/operation/accesshash" 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 cPanel account access hash</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSH-Keys-and-Connections/operation/authorizesshkey" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 SSH key for server</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSH-Keys-and-Connections/operation/generatesshkeypair" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 SSH key pair</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSH-Keys-and-Connections/operation/check_remote_ssh_connection" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 SSH connection to another server</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSH-Keys-and-Connections/operation/convertopensshtoputty" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Migrate OpenSSH key to PuTTY format</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSH-Keys-and-Connections/operation/importsshkey" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 SSH key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSH-Keys-and-Connections/operation/listsshkeys" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 keys list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSH-Keys-and-Connections/operation/deletesshkey" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 SSH key</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Two-Factor-Authentication" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Two-Factor Authentication" class="sc-enMaOJ bBONey">Two-Factor 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/Two-Factor-Authentication/operation/twofactorauth_get_tfa_config_for_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 cPanel account 2FA data</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Authentication/operation/twofactorauth_set_tfa_config_for_user" 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">Update cPanel account's 2FA data</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Authentication/operation/twofactorauth_disable_policy" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 2FA</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Authentication/operation/twofactorauth_enable_policy" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 2FA</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Authentication/operation/twofactorauth_get_issuer" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return configured issuer for current user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Authentication/operation/twofactorauth_remove_user_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">Remove 2FA settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Authentication/operation/twofactorauth_generate_tfa_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">Create a one-time authentication secret and code</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Authentication/operation/twofactorauth_policy_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 2FA policy status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Authentication/operation/twofactorauth_get_user_configs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 2FA enabled</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Authentication/operation/twofactorauth_set_tfa_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">Update 2FA authentication secret and code</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Authentication/operation/twofactorauth_set_issuer" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 2FA issuer value</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Backups" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Backups" class="sc-enMaOJ bBONey">Backups</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Backup-Destination" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Backup Destination" class="sc-enMaOJ bBONey">Backup Destination</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-Destination/operation/backup_destination_add" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 backup destination</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-Destination/operation/backup_destination_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 a backup destination</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-Destination/operation/backup_destination_get" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 backup destination's settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-Destination/operation/backup_destination_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">Update backup destination settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-Destination/operation/backup_does_client_id_have_google_credentials" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Google Drive™ client ID credentials</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-Destination/operation/backup_destination_validate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 a backup destination</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-Destination/operation/backup_generate_google_oauth_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">Create Google Drive™ OAuth redirect URI</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-Destination/operation/backup_destination_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 a list of backup destinations</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Backup-or-Restore" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Backup or Restore" class="sc-enMaOJ bBONey">Backup or Restore</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-or-Restore/operation/backup_list_transported" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 sent through transport</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-or-Restore/operation/backup_set_list_combined" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 for the server's accounts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-or-Restore/operation/fetch_pkgacct_master_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 start_background_pkgacct session log file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-or-Restore/operation/backup_set_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 backup files in the local disk</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-or-Restore/operation/get_pkgacct_session_state" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return start_background_pkgacct session state</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-or-Restore/operation/get_users_and_domains_with_backup_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 users and domains with backup metadata</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-or-Restore/operation/get_users_with_backup_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 users with backup metadata</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-or-Restore/operation/list_cparchive_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 cparchive files list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-or-Restore/operation/start_background_pkgacct" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 an account using the pkgacct script</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-or-Restore/operation/backup_get_transport_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 backup transport events' status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-or-Restore/operation/start_local_cpmove_restore" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 one cPanel account from a backup</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Backup-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Backup Settings" class="sc-enMaOJ bBONey">Backup 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/Backup-Settings/operation/backup_config_set" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 the system's backup configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-Settings/operation/backup_date_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 dates where backup files exist</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-Settings/operation/backup_skip_users_all" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 backups</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-Settings/operation/backup_skip_users_all_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 backup configuration status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-Settings/operation/backup_user_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 users with a backup file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-Settings/operation/toggle_user_backup_state" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 legacy backups</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup-Settings/operation/backup_config_get" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 configuration file data</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Legacy-Migration" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Legacy Migration" class="sc-enMaOJ bBONey">Legacy Migration</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/Legacy-Migration/operation/convert_and_migrate_from_legacy_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">Migrate server to new backup system</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/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 and return access token</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Configuration-Management" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Configuration Management" class="sc-enMaOJ bBONey">Configuration Management</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Configuration" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Configuration" class="sc-enMaOJ bBONey">Configuration</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/Configuration/operation/leika_get_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">Retrieve Leika configuration</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/cPanel-Market" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="cPanel Market" class="sc-enMaOJ bBONey">cPanel Market</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Product-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Product Management" class="sc-enMaOJ bBONey">Product 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/Product-Management/operation/get_adjusted_market_providers_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 Market providers' products adjusted prices</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Product-Management/operation/get_market_providers_product_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 Market providers' products metadata</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Product-Management/operation/Market-get_market_providers_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 Market providers products</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Product-Management/operation/set_market_product_attribute" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Market provider product</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Provider-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Provider Management" class="sc-enMaOJ bBONey">Provider 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/Provider-Management/operation/disable_market_provider" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Market provider</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Provider-Management/operation/enable_market_provider" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Market provider</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Provider-Management/operation/get_market_providers_commission_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 Market providers' commission configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Provider-Management/operation/get_market_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 Market providers</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Provider-Management/operation/set_market_provider_commission_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">Update Market provider commission contact ID</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/cPanel-Support-Tickets" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="cPanel Support Tickets" class="sc-enMaOJ bBONey">cPanel Support Tickets</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Support-Access" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Support Access" class="sc-enMaOJ bBONey">Support Access</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/Support-Access/operation/ticket_grant" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Support SSH key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Support-Access/operation/ticket_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">Delete Support SSH key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Support-Access/operation/ticket_remove_closed" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Support SSH key and closed tickets</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Support-Access/operation/ticket_ssh_test" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Customer Portal connection</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Support-Access/operation/ticket_ssh_test_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">Validate Support SSH connection</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Support-Access/operation/ticket_whitelist_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">Validate Support IP addresses on firewall</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Support-Access/operation/ticket_whitelist_setup" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Support IP addresses to firewall</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Support-Access/operation/ticket_whitelist_unsetup" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Support IP addresses from firewall</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Ticket-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Ticket Management" class="sc-enMaOJ bBONey">Ticket 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/Ticket-Management/operation/ticket_create_stub_ticket" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 initial Support ticket request</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Ticket-Management/operation/ticket_get_support_agreement" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Technical Support Agreement text</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Ticket-Management/operation/ticket_get_support_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">Import customer information from Customer Portal</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Ticket-Management/operation/ticket_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 Support ticket status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Ticket-Management/operation/ticket_update_service_agreement_approval" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Technical Support Agreement acceptance</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Ticket-Management/operation/ticket_validate_oauth2_code" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Customer Portal OAuth2 code</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/cPCloud" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="cPCloud" class="sc-enMaOJ bBONey">cPCloud</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/cPCloud" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="cPCloud" class="sc-enMaOJ bBONey">cPCloud</span></label></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Customizations" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Customizations" class="sc-enMaOJ bBONey">Customizations</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Customizations" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Customizations" class="sc-enMaOJ bBONey">Customizations</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/Customizations/operation/retrieve_customizations" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 customization data</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Customizations/operation/update_customizations" 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">Update customization data</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Customizations/operation/delete_customizations" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 customization data</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Databases" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Databases" class="sc-enMaOJ bBONey">Databases</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Manage-MySQL-Server" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Manage MySQL Server" class="sc-enMaOJ bBONey">Manage MySQL 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/Manage-MySQL-Server/operation/background_mysql_upgrade_checker_run" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 status before upgrade</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Manage-MySQL-Server/operation/current_mysql_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 MySQL version</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Manage-MySQL-Server/operation/background_mysql_upgrade_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 MySQL or MariaDB upgrade status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Manage-MySQL-Server/operation/installable_mysql_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 available MySQL versions</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Manage-MySQL-Server/operation/latest_available_mysql_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 latest MySQL version</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Manage-MySQL-Server/operation/update_sql_config" 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">Update the servers SQL configuration.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Manage-MySQL-Server/operation/start_background_mysql_upgrade" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 background MySQL upgrade</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Manage-MySQL-Server/operation/set_local_mysql_root_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 root password</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/MySQL-Databases" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="MySQL Databases" class="sc-enMaOJ bBONey">MySQL 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/MySQL-Databases/operation/list_database_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/MySQL-Databases/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/MySQL-Databases/operation/list_mysql_databases_and_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 databases and users for account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/MySQL-Databases/operation/rename_mysql_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/MySQL-Databases/operation/rename_mysql_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/MySQL-Databases/operation/set_mysql_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><li tabindex="0" depth="2" data-item-id="tag/MySQL-Databases/operation/get_database_optimizations" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 optimizations</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/PostgreSQL-Databases" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="PostgreSQL Databases" class="sc-enMaOJ bBONey">PostgreSQL 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/PostgreSQL-Databases/operation/rename_postgresql_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><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-Databases/operation/set_postgresql_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-Databases/operation/rename_postgresql_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><li tabindex="0" depth="1" data-item-id="tag/Remote-MySQL-Databases" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Remote MySQL Databases" class="sc-enMaOJ bBONey">Remote MySQL 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-MySQL-Databases/operation/remote_mysql_delete_profile" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 remote MySQL profile</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Remote-MySQL-Databases/operation/remote_mysql_initiate_profile_activation" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 remote MySQL profile activation</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Remote-MySQL-Databases/operation/remote_mysql_read_profile" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 profile</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Remote-MySQL-Databases/operation/remote_mysql_monitor_profile_activation" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 profile activation</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Remote-MySQL-Databases/operation/remote_mysql_update_profile" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 remote MySQL profile</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Remote-MySQL-Databases/operation/remote_mysql_validate_profile" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 remote MySQL profile connection</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Remote-MySQL-Databases/operation/remote_mysql_read_profiles" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 profiles</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Remote-MySQL-Databases/operation/remote_mysql_create_profile_via_ssh" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 remote MySQL profile via SSH</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Remote-MySQL-Databases/operation/remote_mysql_create_profile" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 remote MySQL profile</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-Cluster-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="DNS Cluster Settings" class="sc-enMaOJ bBONey">DNS Cluster 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/DNS-Cluster-Settings/operation/set_nameserver" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 remote DNS server's nameserver software</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/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 domain's DNSSEC key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Security/operation/disable_dnssec_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">Disable DNSSEC on domain</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 domain's DNSSEC key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Security/operation/enable_dnssec_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 DNSSEC on domain</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 domain's DNSSEC key</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">Import DNSSEC key</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 key</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 domain's DNSSEC zone key</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/DNS-Zones" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="DNS Zones" class="sc-enMaOJ bBONey">DNS Zones</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-Zones/operation/listzones" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 DNS zones</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Zones/operation/editzonerecord" 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">Update DNS zone record</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Zones/operation/removezonerecord" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 DNS zone record</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Zones/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 domain's DNSKEY record value</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Zones/operation/update_reverse_dns_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">Update reverse DNS cache</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Zones/operation/getzonerecord" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return specific line from domain's DNS configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Zones/operation/cluster_member_has_trust_with" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 DNS cluster server can share records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Zones/operation/killdns" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 DNS zone</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Zones/operation/dumpzone" 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 domain's DNS zone configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Zones/operation/export_zone_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">Export DNS zones in zone file format</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Zones/operation/parse_dns_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-Zones/operation/mass_edit_dns_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-Zones/operation/adddns" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 DNS zone</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Domain-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Domain Management" class="sc-enMaOJ bBONey">Domain 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/Domain-Management/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/Domain-Management/operation/fetch_ds_records_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">Return domain's DS record</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Management/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">Validate local server is authoritative</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Management/operation/resetzone" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 DNS zone to default values</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Management/operation/savemxs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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/Domain-Management/operation/set_nsec3_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 NSEC3 semantics for domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Management/operation/unset_nsec3_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 NSEC semantics for domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Management/operation/addzonerecord" 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">Create DNS zone record</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Management/operation/resolvedomainname" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 IP address</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Management/operation/listmxs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 mail exchanger records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Management/operation/create_parked_domain_for_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 domain alias</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Management/operation/create_subdomain" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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><li tabindex="0" depth="2" data-item-id="tag/Domain-Management/operation/updateuserdomains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 /etc/userdomains file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Management/operation/delete_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">Delete domain</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Resolvers" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Resolvers" class="sc-enMaOJ bBONey">Resolvers</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/Resolvers/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/Resolvers/operation/set_up_dns_resolver_workarounds" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 unbound DNS resolver</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Resolvers/operation/get_nameserver_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 current user's nameservers</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Resolvers/operation/lookupnsip" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return nameserver's IP address</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Resolvers/operation/lookupnsips" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return nameserver's IPv4 and IPv6 addresses</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Resolvers/operation/setresolvers" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 server's resolver nameservers</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Resolvers/operation/update_nameservers_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">Update default nameservers</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Hosting-Plans" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Hosting Plans" class="sc-enMaOJ bBONey">Hosting Plans</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Feature-Access" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Feature Access" class="sc-enMaOJ bBONey">Feature Access</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/Feature-Access/operation/verify_user_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">Return cPanel account feature access</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Feature-Access/operation/remove_override_features_for_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 cPanel account feature list overrides</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Feature-Access/operation/get_users_features_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 cPanel accounts' feature settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Feature-Access/operation/add_override_features_for_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 cPanel account feature list overrides</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Feature-Lists" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Feature Lists" class="sc-enMaOJ bBONey">Feature 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/Feature-Lists/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 dynamicui file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Feature-Lists/operation/create_featurelist" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 feature list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Feature-Lists/operation/delete_featurelist" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 feature list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Feature-Lists/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 current user's available feature lists info</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Feature-Lists/operation/get_feature_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 all features</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Feature-Lists/operation/get_featurelists" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 available feature lists</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Feature-Lists/operation/get_featurelist_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 feature list configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Feature-Lists/operation/update_featurelist" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 feature list</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Hosting-Plan-Extensions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Hosting Plan Extensions" class="sc-enMaOJ bBONey">Hosting Plan Extensions</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/Hosting-Plan-Extensions/operation/addpkgext" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 hosting plan extension</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Hosting-Plan-Extensions/operation/delpkgext" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 hosting plan extension</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Hosting-Plan-Extensions/operation/_getpkgextensionform" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return hosting plan extension templates</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Hosting-Plans" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Hosting Plans" class="sc-enMaOJ bBONey">Hosting Plans</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/Hosting-Plans/operation/killpkg" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 hosting plan</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Hosting-Plans/operation/addpkg" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 hosting plan</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Hosting-Plans/operation/editpkg" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 hosting plan</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Hosting-Plans/operation/listpkgs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 available hosting plans</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Hosting-Plans/operation/matchpkgs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return filtered hosting plans</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Hosting-Plans/operation/getpkginfo" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return hosting plan configuration</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Integrations" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Integrations" class="sc-enMaOJ bBONey">Integrations</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/API-Authentication" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="API Authentication" class="sc-enMaOJ bBONey">API 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/API-Authentication/operation/get_remote_access_hash" 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 remote access file's hash</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Links" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Links" class="sc-enMaOJ bBONey">Links</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/Links/operation/create_integration_group" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 integration link group</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Links/operation/create_integration_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">Create integration link</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Links/operation/get_integration_link_user_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 integration link configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Links/operation/list_integration_groups" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return integration link groups</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Links/operation/list_integration_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 integration links</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Links/operation/remove_integration_group" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 integration link group</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Links/operation/remove_integration_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 integration link</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Links/operation/update_integration_link_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">Update integration link token</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Scripts-Hooks" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Scripts Hooks" class="sc-enMaOJ bBONey">Scripts Hooks</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/Scripts-Hooks/operation/edit_hook" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 script hook</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Scripts-Hooks/operation/list_hooks" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return script hooks list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Scripts-Hooks/operation/delete_hook" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 script hook</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Scripts-Hooks/operation/reorder_hooks" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 script hooks order</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/IP-Address-Management" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="IP Address Management" class="sc-enMaOJ bBONey">IP Address Management</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/IPv4-Address-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="IPv4 Address Settings" class="sc-enMaOJ bBONey">IPv4 Address 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/IPv4-Address-Settings/operation/addips" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 addresses</span></label></li><li tabindex="0" depth="2" data-item-id="tag/IPv4-Address-Settings/operation/delip" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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</span></label></li><li tabindex="0" depth="2" data-item-id="tag/IPv4-Address-Settings/operation/get_shared_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 shared IP address</span></label></li><li tabindex="0" depth="2" data-item-id="tag/IPv4-Address-Settings/operation/listips" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 IP addresses</span></label></li><li tabindex="0" depth="2" data-item-id="tag/IPv4-Address-Settings/operation/setsiteip" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 or cPanel account IP address</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/IPv6-Address-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="IPv6 Address Settings" class="sc-enMaOJ bBONey">IPv6 Address 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/IPv6-Address-Settings/operation/ipv6_enable_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">Add IPv6 address range to accounts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/IPv6-Address-Settings/operation/ipv6_disable_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">Remove IPv6 address range from account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/IPv6-Address-Settings/operation/ipv6_range_add" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 IPv6 address range</span></label></li><li tabindex="0" depth="2" data-item-id="tag/IPv6-Address-Settings/operation/ipv6_range_edit" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 IPv6 address range name or note</span></label></li><li tabindex="0" depth="2" data-item-id="tag/IPv6-Address-Settings/operation/ipv6_range_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 IPv6 address usage</span></label></li><li tabindex="0" depth="2" data-item-id="tag/IPv6-Address-Settings/operation/ipv6_range_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 IPv6 address ranges</span></label></li><li tabindex="0" depth="2" data-item-id="tag/IPv6-Address-Settings/operation/ipv6_range_remove" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 IPv6 address range</span></label></li><li tabindex="0" depth="2" data-item-id="tag/IPv6-Address-Settings/operation/listipv6s" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 IPv6 addresses</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Network-Address-Translation" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Network Address Translation" class="sc-enMaOJ bBONey">Network Address Translation</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/Network-Address-Translation/operation/get_public_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 public IP address of private IP address</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Network-Address-Translation/operation/nat_checkip" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 public IP address for NAT</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Network-Address-Translation/operation/nat_set_public_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">Register NAT IP address to public IP address</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Login-Security-(cPHulk)" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Login Security (cPHulk)" class="sc-enMaOJ bBONey">Login Security (cPHulk)</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Management" class="sc-enMaOJ bBONey">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/Management/operation/flush_cphulk_login_history" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 all login security records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Management/operation/flush_cphulk_login_history_for_ips" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 login security IP address block</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Management/operation/read_cphulk_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 login security list records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Management/operation/create_cphulk_record" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 login security record to list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Management/operation/cphulk_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 login security status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Management/operation/delete_cphulk_record" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 login security record from list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Management/operation/batch_create_cphulk_records" 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">Add login security record to list with comment</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Reporting" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Reporting" class="sc-enMaOJ bBONey">Reporting</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/Reporting/operation/get_countries_with_known_ip_ranges" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return login security country codes</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Reporting/operation/get_cphulk_brutes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return login security brute force attacks</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Reporting/operation/get_cphulk_excessive_brutes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return login security excessive brute force attacks</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Reporting/operation/get_cphulk_user_brutes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return login security brute force attacks by user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Reporting/operation/get_cphulk_failed_logins" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return login security failed logins</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Settings" class="sc-enMaOJ bBONey">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/Settings/operation/enable_cphulk" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 login security</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Settings/operation/disable_cphulk" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 login security</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Settings/operation/load_cphulk_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 login security configuration settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Settings/operation/save_cphulk_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">Save login security configuration settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Settings/operation/set_cphulk_config_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">Update login security configuration settings</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Logs" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Logs" class="sc-enMaOJ bBONey">Logs</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Web-Log-Retention" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Web Log Retention" class="sc-enMaOJ bBONey">Web Log Retention</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/Web-Log-Retention/operation/list_accounts_retention" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 accounts' web log retention settings</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Mail" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Mail" class="sc-enMaOJ bBONey">Mail</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/cPanel-Account-Mail-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="cPanel Account Mail Management" class="sc-enMaOJ bBONey">cPanel Account Mail 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-Mail-Management/operation/unsuspend_outgoing_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">Unsuspend account outgoing email</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-Management/operation/list_pops_for" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 accounts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-Management/operation/get_user_email_forward_destination" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 forward destination</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-Management/operation/set_user_email_forward_destination" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 email forward destination</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-Management/operation/get_unique_recipient_count_per_sender_for_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 cPanel account unique email recipients</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-Management/operation/get_unique_sender_recipient_count_per_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 all cPanel account unique email recipients</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-Management/operation/suspend_outgoing_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">Suspend cPanel account outgoing email</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-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">Remove email account messages by mailbox GUID</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-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">Remove email account messages by Dovecot query</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-Management/operation/get_mailbox_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 cPanel account mailboxes status by name</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-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 mailboxes status list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-Management/operation/emailtrack_search" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 delivery records by search criteria</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-Management/operation/emailtrack_user_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 all cPanel accounts email tracking statistics</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-Management/operation/emailtrack_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 email tracking statistics</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-Management/operation/release_outgoing_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">Release cPanel account queued outgoing emails</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-Management/operation/hold_outgoing_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">Add cPanel account to outbound email hold queue</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Mail-Management/operation/terminate_cpuser_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/Mail-DNS-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Mail DNS Settings" class="sc-enMaOJ bBONey">Mail 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/Mail-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 DMARC records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-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 a DMARC record to a domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-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 domains' DMARC records.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-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">Disable domain's DKIM records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-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 domain's DKIM records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-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 domain's DKIM private key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-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 domain's DKIM keys</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-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">Install domain SPF record</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-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">Install existing private key to DKIM record</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-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 DKIM records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-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 domain SPF records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-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 domain PTR records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-DNS-Settings/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 mail exchanger redirect record</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-DNS-Settings/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 mail exchanger redirect record</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Mail-Server-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Mail Server Settings" class="sc-enMaOJ bBONey">Mail 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/Mail-Server-Settings/operation/generate_mobileconfig" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 mobile profile configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-Server-Settings/operation/normalize_user_email_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">Repair misconfigured email settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-Server-Settings/operation/exim_configuration_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">Repair Exim configuration file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-Server-Settings/operation/fetch_mail_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">Return server mail queue contents</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-Server-Settings/operation/remove_in_progress_exim_config_edit" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Exim configuration files after failed update</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-Server-Settings/operation/validate_current_installed_exim_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">Validate Exim configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-Server-Settings/operation/validate_exim_configuration_syntax" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Exim configure file syntax</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-Server-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 server SNI support status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-Server-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 domain's SNI mail services status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-Server-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">Rebuild mail SNI configuration files</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/block_incoming_email_from_country" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 block on emails from specific countries</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/block_incoming_email_from_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">Add block on emails from specific domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/list_blocked_incoming_email_countries" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return blocked email countries list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/list_blocked_incoming_email_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 blocked email domains list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/unblock_incoming_email_from_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">Remove block on emails from specific domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/unblock_incoming_email_from_country" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 block on emails from specific countries</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/save_spamd_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">Update Apache SpamAssassin™ configuration</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Spam-Protection-(Greylisting)" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Spam Protection (Greylisting)" class="sc-enMaOJ bBONey">Spam Protection (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-Protection-(Greylisting)/operation/delete_cpgreylist_trusted_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">Remove IP address from Greylisting trusted hosts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Protection-(Greylisting)/operation/cPGreyList-create_cpgreylist_trusted_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">Add IP address to Greylisting trusted hosts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_is_server_netblock_trusted" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 trust status of server netblock</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_list_entries_for_common_mail_provider" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 IP addresses of mail providers</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_load_common_mail_providers_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 Greylisting mail providers</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_save_common_mail_providers_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">Update Greylisting new mail provider handling</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_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 Greylisting status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Protection-(Greylisting)/operation/disable_cpgreylist" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_trust_entries_for_common_mail_provider" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 mail provider to Greylisting trusted hosts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Protection-(Greylisting)/operation/load_cpgreylist_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 Greylisting settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Protection-(Greylisting)/operation/save_cpgreylist_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">Update Greylisting settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Protection-(Greylisting)/operation/cPGreyList-cpgreylist_untrust_entries_for_common_mail_provider" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 mail provider to Greylisting non-trusted hosts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Protection-(Greylisting)/operation/cPGreyList-read_cpgreylist_deferred_entries" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 deferred incoming email triplets</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Protection-(Greylisting)/operation/enable_cpgreylist" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Protection-(Greylisting)/operation/read_cpgreylist_trusted_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 Greylisting trusted hosts</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/NGINX-Manager" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="NGINX Manager" class="sc-enMaOJ bBONey">NGINX Manager</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/NGINX-Manager" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="NGINX Manager" class="sc-enMaOJ bBONey">NGINX 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/NGINX-Manager/operation/nginxmanager_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 the user's NGINX cache.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/NGINX-Manager/operation/nginxmanager_set_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">Update NGINX caching status.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/NGINX-Manager/operation/nginxmanager_get_cache_config_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 user NGINX caching configurations.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/NGINX-Manager/operation/nginxmanager_reset_users_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">Restore NGINX configuration to default values.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/NGINX-Manager/operation/nginxmanager_rebuild_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">Update NGINX configuration.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/NGINX-Manager/operation/nginxmanager_get_cache_config_system" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return NGINX caching configurations.</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/RemoteStorage" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="RemoteStorage" class="sc-enMaOJ bBONey">RemoteStorage</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/RemoteStorage" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="RemoteStorage" class="sc-enMaOJ bBONey">RemoteStorage</span></label></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Resellers" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Resellers" class="sc-enMaOJ bBONey">Resellers</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Account-Enhancement-Limit" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Account Enhancement Limit" class="sc-enMaOJ bBONey">Account Enhancement Limit</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-Enhancement-Limit/operation/list_enhancement_limits" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 enhancement limits</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Enhancement-Limit/operation/set_enhancement_limit" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 enhancement limit</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Account-Limits" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Account Limits" class="sc-enMaOJ bBONey">Account Limits</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-Limits/operation/setresellerpackagelimit" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 reseller's hosting plan limits</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Limits/operation/setresellerlimits" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 reseller's bandwidth and disk quotas</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Account-Permissions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Account Permissions" class="sc-enMaOJ bBONey">Account Permissions</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-Permissions/operation/setacls" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 or update reseller privilege settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Permissions/operation/listacls" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 privilege lists and settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Permissions/operation/saveacllist" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 or update privilege list and settings</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Account-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Account Settings" class="sc-enMaOJ bBONey">Account 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/Account-Settings/operation/get_public_contact" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 public contact information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Settings/operation/set_public_contact" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 user's public contact information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Settings/operation/acctcounts" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 owned accounts' information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Settings/operation/listresellers" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 resellers</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Settings/operation/getresellerips" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 available IP addresses</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Settings/operation/resellerstats" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Settings/operation/setresellerips" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 addresses to reseller</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Settings/operation/setresellermainip" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 reseller's main IP address</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Settings/operation/setresellernameservers" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 reseller's assigned nameservers</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Reseller-Account-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Reseller Account Management" class="sc-enMaOJ bBONey">Reseller 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/Reseller-Account-Management/operation/setupreseller" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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's reseller status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Reseller-Account-Management/operation/suspendreseller" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 reseller</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Reseller-Account-Management/operation/unsetupreseller" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disables cPanel account's reseller status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Reseller-Account-Management/operation/terminatereseller" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 reseller and reseller's cPanel accounts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Reseller-Account-Management/operation/unsuspendreseller" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 reseller</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/WHM-Access" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="WHM Access" class="sc-enMaOJ bBONey">WHM Access</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/WHM-Access/operation/restrict_whm_root_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">Restrict Access to WHM by CIDR list.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WHM-Access/operation/allow_all_whm_root_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">Clear all CIDR restrictions to login to cPanel & WHM with the root password.</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Server-Administration" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Server Administration" class="sc-enMaOJ bBONey">Server Administration</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Configuration-Clusters" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Configuration Clusters" class="sc-enMaOJ bBONey">Configuration Clusters</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/Configuration-Clusters/operation/delete_configclusterserver" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 server from configuration cluster</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Configuration-Clusters/operation/add_configclusterserver" 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">Add configuration cluster server</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Configuration-Clusters/operation/list_configclusterservers" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 configuration cluster servers</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Configuration-Clusters/operation/update_configclusterserver" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 configuration cluster server credentials</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Configuration-Clusters/operation/restore_config_from_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">Update configuration file from backup</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Configuration-Clusters/operation/restore_config_from_upload" 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">Update configuration file from backup via POST</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Configurations" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Configurations" class="sc-enMaOJ bBONey">Configurations</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/Configurations/operation/set_tweaksetting" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 Tweak Settings option</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Configurations/operation/get_tweaksetting" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Tweak Settings option's value</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Connected-Applications" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Connected Applications" class="sc-enMaOJ bBONey">Connected 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/Connected-Applications/operation/list_connected_applications" 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">List application connection information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Connected-Applications/operation/save_connected_application" 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 application connection information.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Connected-Applications/operation/fetch_connected_application" 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">Fetch application connection information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Connected-Applications/operation/remove_connected_application" 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">Remove application connection information</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Connections" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Connections" class="sc-enMaOJ bBONey">Connections</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/Connections/operation/get_tcp6_sockets" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return TCP IPv6 sockets data</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Connections/operation/get_udp4_sockets" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return UDP IPv4 sockets data</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Connections/operation/get_tcp4_sockets" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return TCP IPv4 sockets data</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Connections/operation/get_udp6_sockets" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return UDP IPv6 sockets data</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/cPanel-Analytics" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="cPanel Analytics" class="sc-enMaOJ bBONey">cPanel Analytics</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-Analytics/operation/participate_in_analytics" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 analytics data gathering</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/License-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="License Management" class="sc-enMaOJ bBONey">License 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/License-Management/operation/purchase_a_license" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 Store or Market checkout URL</span></label></li><li tabindex="0" depth="2" data-item-id="tag/License-Management/operation/run_cpkeyclt" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 cPanel license status</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_all_contact_importances" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Contact Manager event importance settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Notifications/operation/get_application_contact_importance" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 contact importance setting</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Notifications/operation/get_application_contact_event_importance" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 event contact importance setting</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Notifications/operation/set_application_contact_event_importance" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 app's event contact importance setting</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Notifications/operation/set_application_contact_importance" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 app contact importance setting</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Notifications/operation/send_test_posturl" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 notification URL via POST</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Notifications/operation/update_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">Update WHM contact email address</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Notifications/operation/send_test_pushbullet_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">Send Pushbullet™ test with access token</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Notifications/operation/verify_oscar_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">Validate ICQ username and password</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Notifications/operation/verify_icq_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">Validate stored ICQ username and password</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Notifications/operation/verify_posturl_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">Send notification URL via POST verification</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Notifications/operation/verify_pushbullet_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">Send Pushbullet™ access verification</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Notifications/operation/verify_slack_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">Verify Slack® Webhook connection</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Security" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Security" class="sc-enMaOJ bBONey">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/Security/operation/fetch_security_advice" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Security Advisor results</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Server-Nodes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Server Nodes" class="sc-enMaOJ bBONey">Server Nodes</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/Server-Nodes/operation/get_linked_server_node" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return linked remote server node settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Nodes/operation/get_server_node_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 linked server node status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Nodes/operation/list_linked_server_nodes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 linked server nodes</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Nodes/operation/list_user_child_nodes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 server name and type</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Nodes/operation/link_server_node_with_api_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">Add linked server node</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Nodes/operation/unlink_server_node" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 linked server node</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Nodes/operation/update_linked_server_node" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 linked server node settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Nodes/operation/force_dedistribution_from_node" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 distributed accounts with data loss</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Server-Profiles" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Server Profiles" class="sc-enMaOJ bBONey">Server Profiles</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/Server-Profiles/operation/is_role_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 server role is enabled</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Profiles/operation/get_current_profile" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 node profile</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Profiles/operation/get_available_profiles" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 server profiles</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Profiles/operation/start_profile_activation" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 server node profile</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Services" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Services" class="sc-enMaOJ bBONey">Services</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/Services/operation/get_service_config_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 service configuration key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Services/operation/set_service_config_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">Update service configuration key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Services/operation/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">Update cPanel account service proxying</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Services/operation/servicestatus" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Services/operation/enable_monitor_all_enabled_services" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 monitoring for all services</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Services/operation/configureservice" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 a service and its monitoring</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Services/operation/restartservice" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Restart service</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Services/operation/configurebackgroundprocesskiller" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 background process stopper</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Services/operation/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/Services/operation/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/Services/operation/get_service_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 service configuration settings</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/System-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="System Information" class="sc-enMaOJ bBONey">System 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/System-Information/operation/system_needs_reboot" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 system needs reboot</span></label></li><li tabindex="0" depth="2" data-item-id="tag/System-Information/operation/systemloadavg" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 load average</span></label></li><li tabindex="0" depth="2" data-item-id="tag/System-Information/operation/sethostname" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 server's hostname</span></label></li><li tabindex="0" depth="2" data-item-id="tag/System-Information/operation/set_primary_servername" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 server's primary virtual host</span></label></li><li tabindex="0" depth="2" data-item-id="tag/System-Information/operation/getdiskusage" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 drive partition information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/System-Information/operation/gethostname" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 hostname</span></label></li><li tabindex="0" depth="2" data-item-id="tag/System-Information/operation/reboot" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Restart server</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Updates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Updates" class="sc-enMaOJ bBONey">Updates</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/Updates/operation/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 third-party software versions</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Updates/operation/update_updateconf" 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">Update software update behavior</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Updates/operation/accept_eula" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 EULA acceptance</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Updates/operation/set_tier" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 & WHM release tier</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Updates/operation/get_available_tiers" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 & WHM available versions</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Updates/operation/set_cpanel_updates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 & WHM update frequency</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Updates/operation/get_current_lts_expiration_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 Long Term Support expiration status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Updates/operation/get_lts_wexpire" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Long Term Support status for all versions</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Updates/operation/get_update_availability" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 server uses the default update version</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Updates/operation/start_cpanel_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">Start cPanel & WHM update</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Updates/operation/manage_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">Update Feature Showcase</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Updates/operation/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 cPanel & WHM version</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/ServicesCluster" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="ServicesCluster" class="sc-enMaOJ bBONey">ServicesCluster</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/ServicesCluster" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="ServicesCluster" class="sc-enMaOJ bBONey">ServicesCluster</span></label></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-Certificates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Auto-Generated Certificates" class="sc-enMaOJ bBONey">Auto-Generated 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-Certificates/operation/add_autossl_user_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 domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/disable_autossl" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/get_autossl_check_schedule" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 check script cron entry</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/get_autossl_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 AutoSSL log file's contents</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/get_autossl_logs_catalog" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 log files</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/get_autossl_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 current user's AutoSSL metadata</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/get_autossl_user_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 all AutoSSL-excluded domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/get_autossl_providers" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 AutoSSL providers</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/start_autossl_check_for_one_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">Start cPanel account AutoSSL check</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/remove_autossl_user_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">Remove AutoSSL for domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/set_autossl_metadata_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">Update AutoSSL metadata via JSON</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/set_autossl_provider" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 the AutoSSL provider</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/set_autossl_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">Update AutoSSL metadata</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/set_autossl_user_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 domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/start_autossl_check_for_all_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">Start AutoSSL check for all cPanel accounts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-Generated-Certificates/operation/reset_autossl_provider" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 AutoSSL registration</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/cPanel-Account-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="cPanel Account Settings" class="sc-enMaOJ bBONey">cPanel Account 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/cPanel-Account-Settings/operation/fetchcrtinfo" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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-Settings/operation/fetchsslinfo" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 SSL certificate information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Settings/operation/fetch_ssl_vhosts" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 vhosts and SSL certificates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Settings/operation/delete_ssl_vhost" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 vhost</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Settings/operation/enqueue_deferred_ssl_installations" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 SSL certificate to installation queue</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Settings/operation/fetch_ssl_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 cPanel account FQDN certificate information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Settings/operation/fetch_vhost_ssl_components" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 certificate components on vhost</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Settings/operation/get_autossl_problems_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">Return domain DCV issues</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Settings/operation/get_autossl_problems_for_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 account DCV issues</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Settings/operation/get_best_ssldomain_for_service" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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-encrypted domain for service access</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Settings/operation/install_service_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">Install SSL certificate for service</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Settings/operation/installssl" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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></ul></li><li tabindex="0" depth="1" data-item-id="tag/SSL-Server-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="SSL Server Settings" class="sc-enMaOJ bBONey">SSL 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/SSL-Server-Settings/operation/fetch_service_ssl_components" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 services and associated certificates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Server-Settings/operation/generatessl" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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-Server-Settings/operation/listcrts" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 installed SSL certificates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Server-Settings/operation/rebuilduserssldb" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 users database</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Server-Settings/operation/reset_service_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">Create self-signed SSL certificate for service</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/System-Package-Management" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="System Package Management" class="sc-enMaOJ bBONey">System Package Management</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Install-or-Uninstall-Package" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Install or Uninstall Package" class="sc-enMaOJ bBONey">Install or Uninstall Package</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/Install-or-Uninstall-Package/operation/package_manager_submit_actions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 RPM package installation, update, or removal</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Install-or-Uninstall-Package/operation/package_manager_upgrade" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 RPM package upgrade</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Install-or-Uninstall-Package/operation/install_rpm_plugin" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 WHM plugin RPM package</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Install-or-Uninstall-Package/operation/uninstall_rpm_plugin" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Uninstall WHM plugin RPM package</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/List-Package-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="List Package Information" class="sc-enMaOJ bBONey">List Package 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/List-Package-Information/operation/package_manager_is_performing_actions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return RPM package update status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/List-Package-Information/operation/package_manager_list_packages" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 RPM packages</span></label></li><li tabindex="0" depth="2" data-item-id="tag/List-Package-Information/operation/get_rpm_version_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 available RPM packages</span></label></li><li tabindex="0" depth="2" data-item-id="tag/List-Package-Information/operation/list_rpms" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return required but uninstalled server RPM package</span></label></li><li tabindex="0" depth="2" data-item-id="tag/List-Package-Information/operation/package_manager_get_package_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 available RPM packages information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/List-Package-Information/operation/package_manager_resolve_actions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return possible RPM package changes</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Package-Manager-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Package Manager Settings" class="sc-enMaOJ bBONey">Package 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/Package-Manager-Settings/operation/package_manager_get_build_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 RPM management build log</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Package-Manager-Settings/operation/package_manager_fixcache" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 RPM management yum cache issues</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Package-Manager-Settings/operation/delete_rpm_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">Remove rpm.versions system configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Package-Manager-Settings/operation/edit_rpm_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">Update rpm.versions system configuration</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Transfers" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Transfers" class="sc-enMaOJ bBONey">Transfers</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/cPanel-Account-Transfer" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="cPanel Account Transfer" class="sc-enMaOJ bBONey">cPanel Account Transfer</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-Transfer/operation/abort_transfer_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 transfer session</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Transfer/operation/create_remote_root_transfer_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">Create remote server transfer session as root user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Transfer/operation/enqueue_transfer_item" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 module to transfer session</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Transfer/operation/pause_transfer_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">Suspend active transfer session</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Transfer/operation/start_transfer_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">Start or restart transfer session</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-Transfer/operation/create_remote_user_transfer_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">Create remote server transfer session</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Transfer-Configuration" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Transfer Configuration" class="sc-enMaOJ bBONey">Transfer Configuration</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/Transfer-Configuration/operation/remote_basic_credential_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">Validate remote server's SSH credentials</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Transfer-Configuration/operation/validate_system_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">Validate username availability on target server</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Transfer-Configuration/operation/delete_account_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">Remove cPanel account's archives</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Transfer-Configuration/operation/transfer_module_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 a transfer module's schema</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Transfer-Monitoring" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Transfer Monitoring" class="sc-enMaOJ bBONey">Transfer Monitoring</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/Transfer-Monitoring/operation/analyze_transfer_session_remote" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 remote server's credentials</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Transfer-Monitoring/operation/available_transfer_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 available transfer modules</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Transfer-Monitoring/operation/fetch_transfer_session_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 transfer session's log file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Transfer-Monitoring/operation/get_transfer_session_state" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return transfer session's status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Transfer-Monitoring/operation/retrieve_transfer_session_remote_analysis" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return transfer session's information</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/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><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/EasyApache-Settings/operation/ea4_get_currently_installed_packages" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 Easyapache 4 packages</span></label></li><li tabindex="0" depth="2" data-item-id="tag/EasyApache-Settings/operation/ea4_metainfo" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return ea4-metainfo.json file contents</span></label></li><li tabindex="0" depth="2" data-item-id="tag/EasyApache-Settings/operation/ea4_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">Return EasyApache 4 recommendations</span></label></li><li tabindex="0" depth="2" data-item-id="tag/EasyApache-Settings/operation/ea4_save_profile" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 EasyApache 4 profile</span></label></li><li tabindex="0" depth="2" data-item-id="tag/EasyApache-Settings/operation/ea4_get_additional_pkg_prefixes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return any additional package prefixes, beyond `ea`.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/EasyApache-Settings/operation/ea4_list_profiles" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return EasyApache 4 profiles</span></label></li></ul></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/php_get_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 PHP handlers</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP/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 PHP preconfigured domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP/operation/php_ini_set_content" 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">Update PHP version's php.ini file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP/operation/php_ini_get_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 PHP version's php.ini file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP/operation/php_set_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">Update default PHP version</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP/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 PHP version of all virtual hosts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP/operation/php_set_session_save_path" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 PHP default save path</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP/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/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 domain's PHP values</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP/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 system default PHP version</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP/operation/php_ini_set_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 PHP version's directives</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP/operation/php_ini_get_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 PHP version's directives</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP/operation/php_set_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">Update PHP version's handler</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP/operation/php_get_vhosts_by_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 virtual hosts per PHP version</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/PHP-FPM" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="PHP-FPM" class="sc-enMaOJ bBONey">PHP-FPM</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-FPM/operation/convert_all_domains_to_fpm" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 PHP-FPM on all domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-FPM/operation/php_fpm_config_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">Update PHP-FPM directives and pool options</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-FPM/operation/is_conversion_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 PHP-FPM conversion status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-FPM/operation/php_get_old_fpm_flag" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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-FPM preconfigured status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-FPM/operation/php_set_default_accounts_to_fpm" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 PHP-FPM on new cPanel accounts and domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-FPM/operation/php_set_old_fpm_flag" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 PHP-FPM preconfigured status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-FPM/operation/get_fpm_count_and_utilization" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return workload data for PHP-FPM on all domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-FPM/operation/php_fpm_config_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">Return PHP-FPM directives and pool options</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-FPM/operation/php_get_default_accounts_to_fpm" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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-FPM status on new accounts</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Web-Server-Security-(ModSecurity)" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Web Server Security (ModSecurity)" class="sc-enMaOJ bBONey">Web Server Security (ModSecurity)</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Rule-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Rule Settings" class="sc-enMaOJ bBONey">Rule 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/Rule-Settings/operation/modsec_add_rule" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 staged ModSecurity rule</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Settings/operation/modsec_check_rule" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 ModSecurity rule</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Settings/operation/modsec_clone_rule" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 ModSecurity rule copy</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Settings/operation/modsec_deploy_all_rule_changes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 staged ModSecurity rule changes</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Settings/operation/modsec_deploy_rule_changes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 staged ModSecurity rule changes</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Settings/operation/modsec_discard_all_rule_changes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 all staged ModSecurity rule changes</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Settings/operation/modsec_disable_rule" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 rule</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Settings/operation/modsec_discard_rule_changes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 staged ModSecurity rule changes</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Settings/operation/modsec_edit_rule" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 staged ModSecurity rule</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Settings/operation/modsec_get_rules" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 rules</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Settings/operation/modsec_remove_rule" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 ModSecurity rule</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Settings/operation/modsec_report_rule" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 ModSecurity rule error report</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Settings/operation/modsec_undisable_rule" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 rule</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Rule-Vendor-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Rule Vendor Settings" class="sc-enMaOJ bBONey">Rule Vendor 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/Rule-Vendor-Settings/operation/modsec_add_vendor" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 ModSecurity vendor rules</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Vendor-Settings/operation/modsec_disable_vendor_configs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 vendor configuration files</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Vendor-Settings/operation/modsec_disable_vendor_updates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 vendor updates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Vendor-Settings/operation/modsec_enable_vendor" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 vendor rules</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Vendor-Settings/operation/modsec_enable_vendor_configs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 vendor configuration files</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Vendor-Settings/operation/modsec_enable_vendor_updates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 vendor updates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Vendor-Settings/operation/modsec_get_vendors" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 vendors</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Vendor-Settings/operation/modsec_disable_vendor" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 vendor rules</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Vendor-Settings/operation/modsec_preview_vendor" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 vendor rule metadata</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Vendor-Settings/operation/modsec_remove_vendor" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 ModSecurity vendor</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Rule-Vendor-Settings/operation/modsec_update_vendor" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 ModSecurity vendor ruleset</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Server-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Server Settings" class="sc-enMaOJ bBONey">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/Server-Settings/operation/modsec_assemble_config_text" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 ModSecurity configuration file text</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Settings/operation/modsec_batch_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">Run ModSecurity batch settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Settings/operation/modsec_get_config_text" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 configuration file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Settings/operation/modsec_get_configs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><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 ModSecurity configuration files</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Settings/operation/modsec_get_configs_with_changes_pending" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return staged ModSecurity configuration files</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Settings/operation/modsec_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 ModSecurity logs</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Settings/operation/modsec_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">Return ModSecurity configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Settings/operation/modsec_is_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 module status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Settings/operation/modsec_make_config_inactive" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 ModSecurity configuration file include</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Settings/operation/modsec_make_config_active" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 ModSecurity configuration file include</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Settings/operation/modsec_remove_setting" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 ModSecurity configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Settings/operation/modsec_set_config_text" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 ModSecurity configuration file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Settings/operation/modsec_set_setting" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 ModSecurity configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Server-Settings/operation/modsec_deploy_settings_changes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -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 staged ModSecurity configuration files</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">WHM API<!-- --> </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>WHM API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>WHM API.</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/Restore-Account" data-section-id="tag/Restore-Account" 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/Restore-Account" aria-label="tag/Restore-Account"></a>Restore Account</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Account Restoration / Restore Account</p>
"><p>Account Restoration / Restore Account</p>
</div></div></div><div id="tag/Restore-Account/operation/restore_queue_add_task" data-section-id="tag/Restore-Account/operation/restore_queue_add_task" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_queue_add_task" id="operation/restore_queue_add_task" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Account/operation/restore_queue_add_task" aria-label="tag/Restore-Account/operation/restore_queue_add_task"></a>Restore user account from backup<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function restores a user&#39;s cPanel account from a backup file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores a user's cPanel account from a backup 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="destid" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">destid</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"local"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">destid=LmTZCUpqqLSPH8AO7pVtIeNK</span></div><div><div html="<p>The destination&#39;s identification string.</p>
<ul>
<li><code>local</code> — The local directory.</li>
<li>The destination ID string&#39;s value.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The destination's identification string.</p>
<ul>
<li><code>local</code> — The local directory.</li>
<li>The destination ID string's value.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="give_ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">give_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">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">give_ip=1</span></div><div><div html="<p>Whether to assign the account a dedicated IP address.</p>
<ul>
<li><code>1</code> — Assign a dedicated IP address.</li>
<li><code>0</code> — Use the shared IP address.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to assign the account a dedicated IP address.</p>
<ul>
<li><code>1</code> — Assign a dedicated IP address.</li>
<li><code>0</code> — Use the shared IP address.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="mail_config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mail_config</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">mail_config=1</span></div><div><div html="<p>Whether to restore the account&#39;s email configuration.</p>
<ul>
<li><code>1</code> — Restore.</li>
<li><code>0</code> — Do <strong>not</strong> restore.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to restore the account's email configuration.</p>
<ul>
<li><code>1</code> — Restore.</li>
<li><code>0</code> — Do <strong>not</strong> restore.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="mysql" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mysql</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">mysql=1</span></div><div><div html="<p>Whether to restore the account&#39;s MySQL® databases.</p>
<ul>
<li><code>1</code> — Restore.</li>
<li><code>0</code> — Do <strong>not</strong> restore.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to restore the account's MySQL® databases.</p>
<ul>
<li><code>1</code> — Restore.</li>
<li><code>0</code> — Do <strong>not</strong> restore.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="restore_point" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">restore_point</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">restore_point=2019-10-21T00:00:00.000Z</span></div><div><div html="<p>The date of the backup to use, in <code>YYYY-MM-DD</code> format.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The date of the backup to use, in <code>YYYY-MM-DD</code> format.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="subdomains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">subdomains</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">subdomains=1</span></div><div><div html="<p>Whether to restore the account&#39;s subdomains.</p>
<ul>
<li><code>1</code> — Restore.</li>
<li><code>0</code> — Do <strong>not</strong> restore.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to restore the account's subdomains.</p>
<ul>
<li><code>1</code> — Restore.</li>
<li><code>0</code> — Do <strong>not</strong> restore.</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=username</span></div><div><div html="<p>The cPanel account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/restore_queue_add_task</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_queue_add_task</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155j0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155j0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155j0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155j0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155j0q:0" aria-labelledby="tab:R155j0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_queue_add_task <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">restore_point</span><span class="token operator">=</span><span class="token string">'2019-10-21T00:00:00.000Z'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155j0q:1" aria-labelledby="tab:R155j0q: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:R175j0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175j0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175j0q:0" aria-labelledby="tab:R175j0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"queue_id"</span>: <span class="token string">"3b99QG5fp99tdL5"</span></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">"command"</span>: <span class="token string">"restore_queue_add_task"</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/Restore-Account/operation/restoreaccount" data-section-id="tag/Restore-Account/operation/restoreaccount" class="sc-dntaoT ceciOs"><div data-section-id="operation/restoreaccount" id="operation/restoreaccount" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Account/operation/restoreaccount" aria-label="tag/Restore-Account/operation/restoreaccount"></a>Restore account backup<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function restores an account backup. You can use this function to restore daily,
weekly, or monthly backups.</p>
<p><strong>Important:</strong></p>
<ul>
<li><p>When you call this function, you <strong>must</strong> include at least one of
the <code>all</code>, <code>mail</code>, <code>subs</code>, or <code>mysql</code> parameters.</p>
</li>
<li><p>On servers with a custom <code>Whostmgr::Transfers</code> module, the function may not return XML
output. To properly return XML output, the <code>Whostmgr::Transfers</code> module <strong>must</strong> allow
the system to use the <code>Cpanel::Demultiplexer</code> module to capture output.</p>
</li>
</ul>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of SPF
resource records on DNS.</p>
<ul>
<li><p>This warning is not relevant on CentOS 7 servers, because
<a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>.
CentOS 7 servers use <code>TXT</code> records instead of <code>SPF</code> records.</p>
</li>
<li><p>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated
version of BIND that complies with RFC 7208. To resolve this issue, update your
operating system to a version that contains the updated version of BIND. For more
information, read the
<a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</p>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores an account backup. You can use this function to restore daily,
weekly, or monthly backups.</p>
<p><strong>Important:</strong></p>
<ul>
<li><p>When you call this function, you <strong>must</strong> include at least one of
the <code>all</code>, <code>mail</code>, <code>subs</code>, or <code>mysql</code> parameters.</p>
</li>
<li><p>On servers with a custom <code>Whostmgr::Transfers</code> module, the function may not return XML
output. To properly return XML output, the <code>Whostmgr::Transfers</code> module <strong>must</strong> allow
the system to use the <code>Cpanel::Demultiplexer</code> module to capture output.</p>
</li>
</ul>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of SPF
resource records on DNS.</p>
<ul>
<li><p>This warning is not relevant on CentOS 7 servers, because
<a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>.
CentOS 7 servers use <code>TXT</code> records instead of <code>SPF</code> records.</p>
</li>
<li><p>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated
version of BIND that complies with RFC 7208. To resolve this issue, update your
operating system to a version that contains the updated version of BIND. For more
information, read the
<a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</p>
</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="all" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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"> <!-- -->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=1</span></div><div><div html="<p>Whether to create the account before restoration.</p>
<ul>
<li><code>1</code> — Create and then restore the account. If you select this value and the
account already exists, the function will fail.</li>
<li><code>0</code> — Restore <strong>only</strong>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to create the account before restoration.</p>
<ul>
<li><code>1</code> — Create and then restore the account. If you select this value and the
account already exists, the function will fail.</li>
<li><code>0</code> — Restore <strong>only</strong>.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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">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">ip=1</span></div><div><div html="<p>Whether to assign a dedicated IP address to the restored account.</p>
<ul>
<li><code>1</code> — Assign a dedicated IP address.</li>
<li><code>0</code> — Use the shared IP address.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to assign a dedicated IP address to the restored account.</p>
<ul>
<li><code>1</code> — Assign a dedicated IP address.</li>
<li><code>0</code> — Use the shared IP address.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="mail" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mail</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">mail=1</span></div><div><div html="<p>Whether to restore account-level filters (vfilters) and forwarders
(valiases).</p>
<ul>
<li><code>1</code> — Restore.</li>
<li><code>0</code> — Do <strong>not</strong> restore.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to restore account-level filters (vfilters) and forwarders
(valiases).</p>
<ul>
<li><code>1</code> — Restore.</li>
<li><code>0</code> — Do <strong>not</strong> restore.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="mysql" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mysql</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">mysql=1</span></div><div><div html="<p>Whether to restore the account&#39;s MySQL® databases.</p>
<ul>
<li><code>1</code> — Restore.</li>
<li><code>0</code> — Do <strong>not</strong> restore.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to restore the account's MySQL® databases.</p>
<ul>
<li><code>1</code> — Restore.</li>
<li><code>0</code> — Do <strong>not</strong> restore.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="subs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">subs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">subs=1</span></div><div><div html="<p>Whether to restore the account&#39;s subdomains.</p>
<ul>
<li><code>1</code> — Restore.</li>
<li><code>0</code> — Do <strong>not</strong> restore.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to restore the account's subdomains.</p>
<ul>
<li><code>1</code> — Restore.</li>
<li><code>0</code> — Do <strong>not</strong> restore.</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">"monthly"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"weekly"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"daily"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=monthly</span></div><div><div html="<p>The type of backup to restore. The function restores the most recent backup of
the type that you specify:</p>
<ul>
<li><code>monthly</code></li>
<li><code>weekly</code></li>
<li><code>daily</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of backup to restore. The function restores the most recent backup of
the type that you specify:</p>
<ul>
<li><code>monthly</code></li>
<li><code>weekly</code></li>
<li><code>daily</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=username</span></div><div><div html="<p>The account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 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="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">/restoreaccount</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restoreaccount</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R156j0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156j0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156j0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156j0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156j0q:0" aria-labelledby="tab:R156j0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restoreaccount <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'monthly'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156j0q:1" aria-labelledby="tab:R156j0q: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:R176j0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176j0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176j0q:0" aria-labelledby="tab:R176j0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"restoreaccount"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"raw"</span>: <span class="token string">"Extracting tarball...................\nDone<br />\nExtracting Domain....Done<br />\nDone<br />\n<br /><br />Restoring cpanel user config fileDone<br />\n<br />Restoring reseller privs (if any)<br />Restoring Locale Setting<br />Restoring SSL keys and CertificatesDone<br />\n<br />Restoring frontpage (if installed)Done<br />\n<br />Restoring access logs....\nDone<br />\n<br /><br />Restoring domain keys....\nDone<br />\n<br /><br />Restoring DB MAP File....\nDone<br />\n<br /><br /><span class=\"b2\">Restoring PostgreSQL databases....</span>\nRestoring PostgreSQL privs<!--\n-->\nDone<br />\n<br />Restoring Mailman listsDone<br />\n<br />Restoring Mailman ArchivesDone<br />\n<br />Restoring shell<blockquote><pre>Current shell /bin/bash is up to date.\n</pre></blockquote>Done<br />\n<br />Restoring password<blockquote><pre></pre></blockquote>Done<br />\n<br />Restoring proftpd fileDone<br />\n<br />Resyncing FTP Passwords<blockquote><pre>Updating ftp passwords for userFtp password files updated.Ftp vhost passwords synced</pre></blockquote>Done<br />\n<br />Linking old home directories<br />Parsing Domain Databases...ParkedDomains......AddonDomains...<br />Restoring Domains<br />\n<br />Restoring Bandwidth DataDone\n<br />Restoring Counter Data<pre></pre><br />Restoring Homedir....<blockquote><pre></pre></blockquote>Done<br />\n<br />Doing fileprotect conversion<br />Restoring nobody owned filesDone<br />\n<br />Restoring Mail filesDone<br />\n<br />Restoring userdata....\nDone<br />\n<br /><br />Restoring custom virtualhost templates....\nConverting email to cPanel 5+ (if needed)<blockquote><pre></pre></blockquote>Done<br />\n<br />Cleaning up filters (if needed)<blockquote><pre>vfilter converter v3.0Updating vfilter files to latest format.Running for user only (force=0) (has_spam_acl=1)Processing user......Done</pre></blockquote>Done<br />\n<br />Fixing mail permissions<blockquote><pre></pre></blockquote>Done<br />\n<br />Restoring crontabDone<br />\nConverting to maildir if needed<blockquote><pre></pre></blockquote>Done<br />\nRestoring Dns Zones<blockquote><pre>Restoring zone: user.com.db\n</pre></blockquote><br />Adding missing subdomain DNS entries (if needed)<pre></pre><br />Update Proxy subomains<blockquote><pre>Adding proxy subdomains for domain example.com.Records Installed</pre></blockquote>Done<br />\n<br />Updating SPF Records<blockquote><pre></pre></blockquote>Done<br />\n<br />Restoring quota<blockquote><pre></pre></blockquote>Done<br />\n<br /><br />Update mail routing<blockquote><pre>LOCAL MAIL EXCHANGER: This server will serve as a primary mail exchanger for example.com's mail.: This configuration has been manually selected.\n</pre></blockquote>Done<br />\n<br />Rebuilding Apache Conf<br />Restore CompleteAccount Restore Complete\nUnlocking password for user user.passwd: Success.<br />"</span></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">"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/Restore-Account/operation/verify_new_username_for_restore" data-section-id="tag/Restore-Account/operation/verify_new_username_for_restore" class="sc-dntaoT ceciOs"><div data-section-id="operation/verify_new_username_for_restore" id="operation/verify_new_username_for_restore" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Account/operation/verify_new_username_for_restore" aria-label="tag/Restore-Account/operation/verify_new_username_for_restore"></a>Validate username during restoration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks for username conflicts during account restoration. If the function detects a username conflict, it outputs an error message in the <code>reason</code> return.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks for username conflicts during account restoration. If the function detects a username conflict, it outputs an error message in the <code>reason</code> 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><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=username</span></div><div><div html="<p>The cPanel account that you wish to transfer to the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account that you wish to transfer to the 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="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">/verify_new_username_for_restore</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/verify_new_username_for_restore</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R157j0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R157j0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R157j0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R157j0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R157j0q:0" aria-labelledby="tab:R157j0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
verify_new_username_for_restore <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R157j0q:1" aria-labelledby="tab:R157j0q: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:R177j0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R177j0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R177j0q:0" aria-labelledby="tab:R177j0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"verify_new_username_for_restore"</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/Restore-Queue-Management" data-section-id="tag/Restore-Queue-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/Restore-Queue-Management" aria-label="tag/Restore-Queue-Management"></a>Restore Queue Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Account Restoration / Restore Queue Management</p>
"><p>Account Restoration / Restore Queue Management</p>
</div></div></div><div id="tag/Restore-Queue-Management/operation/restore_queue_activate" data-section-id="tag/Restore-Queue-Management/operation/restore_queue_activate" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_queue_activate" id="operation/restore_queue_activate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Queue-Management/operation/restore_queue_activate" aria-label="tag/Restore-Queue-Management/operation/restore_queue_activate"></a>Start restoration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function activates the restore queue. This triggers a process that restores all queued accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function activates the restore queue. This triggers a process that restores all queued 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="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">/restore_queue_activate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_queue_activate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9l0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9l0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9l0q:0" aria-labelledby="tab:R2a9l0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_queue_activate
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9l0q:1" aria-labelledby="tab:R2a9l0q: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:R2e9l0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9l0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9l0q:0" aria-labelledby="tab:R2e9l0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"restore_queue_activate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Restore queue processing initiated"</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/Restore-Queue-Management/operation/restore_queue_clear_all_completed_tasks" data-section-id="tag/Restore-Queue-Management/operation/restore_queue_clear_all_completed_tasks" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_queue_clear_all_completed_tasks" id="operation/restore_queue_clear_all_completed_tasks" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Queue-Management/operation/restore_queue_clear_all_completed_tasks" aria-label="tag/Restore-Queue-Management/operation/restore_queue_clear_all_completed_tasks"></a>Remove all completed restoration tasks<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes successfully completed tasks from the restoration queue.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes successfully completed tasks from the restoration 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="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">/restore_queue_clear_all_completed_tasks</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_queue_clear_all_completed_tasks</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aal0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aal0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aal0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aal0q:0" aria-labelledby="tab:R2aal0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_queue_clear_all_completed_tasks
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aal0q:1" aria-labelledby="tab:R2aal0q: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:R2eal0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eal0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eal0q:0" aria-labelledby="tab:R2eal0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"restore_queue_clear_all_completed_tasks"</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/Restore-Queue-Management/operation/restore_queue_clear_all_failed_tasks" data-section-id="tag/Restore-Queue-Management/operation/restore_queue_clear_all_failed_tasks" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_queue_clear_all_failed_tasks" id="operation/restore_queue_clear_all_failed_tasks" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Queue-Management/operation/restore_queue_clear_all_failed_tasks" aria-label="tag/Restore-Queue-Management/operation/restore_queue_clear_all_failed_tasks"></a>Remove all failed restoration tasks<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes any failed tasks from the restoration queue.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes any failed tasks from the restoration 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="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">/restore_queue_clear_all_failed_tasks</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_queue_clear_all_failed_tasks</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abl0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abl0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abl0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abl0q:0" aria-labelledby="tab:R2abl0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_queue_clear_all_failed_tasks
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl0q:1" aria-labelledby="tab:R2abl0q: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:R2ebl0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebl0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebl0q:0" aria-labelledby="tab:R2ebl0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"restore_queue_clear_all_failed_tasks"</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/Restore-Queue-Management/operation/restore_queue_clear_all_pending_tasks" data-section-id="tag/Restore-Queue-Management/operation/restore_queue_clear_all_pending_tasks" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_queue_clear_all_pending_tasks" id="operation/restore_queue_clear_all_pending_tasks" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Queue-Management/operation/restore_queue_clear_all_pending_tasks" aria-label="tag/Restore-Queue-Management/operation/restore_queue_clear_all_pending_tasks"></a>Remove all pending restoration tasks<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes any pending tasks from the restoration queue.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes any pending tasks from the restoration 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="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">/restore_queue_clear_all_pending_tasks</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_queue_clear_all_pending_tasks</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acl0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acl0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acl0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acl0q:0" aria-labelledby="tab:R2acl0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_queue_clear_all_pending_tasks
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl0q:1" aria-labelledby="tab:R2acl0q: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:R2ecl0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecl0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecl0q:0" aria-labelledby="tab:R2ecl0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"restore_queue_clear_all_pending_tasks"</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/Restore-Queue-Management/operation/restore_queue_clear_all_tasks" data-section-id="tag/Restore-Queue-Management/operation/restore_queue_clear_all_tasks" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_queue_clear_all_tasks" id="operation/restore_queue_clear_all_tasks" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Queue-Management/operation/restore_queue_clear_all_tasks" aria-label="tag/Restore-Queue-Management/operation/restore_queue_clear_all_tasks"></a>Remove all restoration tasks<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes all tasks from the restoration queue.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes all tasks from the restoration 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="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">/restore_queue_clear_all_tasks</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_queue_clear_all_tasks</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adl0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adl0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adl0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adl0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adl0q:0" aria-labelledby="tab:R2adl0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_queue_clear_all_tasks
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adl0q:1" aria-labelledby="tab:R2adl0q: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:R2edl0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edl0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edl0q:0" aria-labelledby="tab:R2edl0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"restore_queue_clear_all_tasks"</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/Restore-Queue-Management/operation/restore_queue_clear_completed_task" data-section-id="tag/Restore-Queue-Management/operation/restore_queue_clear_completed_task" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_queue_clear_completed_task" id="operation/restore_queue_clear_completed_task" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Queue-Management/operation/restore_queue_clear_completed_task" aria-label="tag/Restore-Queue-Management/operation/restore_queue_clear_completed_task"></a>Remove completed restoration task<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes a single completed task from the restoration queue.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a single completed task from the restoration 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="start_time" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">start_time</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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_time=1396065600</span></div><div><div html="<p>When the restoration queue started the restoration.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>When the restoration queue started the restoration.</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=username</span></div><div><div html="<p>The cPanel account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="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">/restore_queue_clear_completed_task</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_queue_clear_completed_task</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ael0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ael0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ael0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ael0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ael0q:0" aria-labelledby="tab:R2ael0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_queue_clear_completed_task <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">start_time</span><span class="token operator">=</span><span class="token string">'1396065600'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ael0q:1" aria-labelledby="tab:R2ael0q: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:R2eel0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eel0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eel0q:0" aria-labelledby="tab:R2eel0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"restore_queue_clear_completed_task"</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/Restore-Queue-Management/operation/restore_queue_clear_pending_task" data-section-id="tag/Restore-Queue-Management/operation/restore_queue_clear_pending_task" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_queue_clear_pending_task" id="operation/restore_queue_clear_pending_task" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Queue-Management/operation/restore_queue_clear_pending_task" aria-label="tag/Restore-Queue-Management/operation/restore_queue_clear_pending_task"></a>Remove pending restoration task<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes a single pending task from the restoration queue.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a single pending task from the restoration 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="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 cPanel account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="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">/restore_queue_clear_pending_task</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_queue_clear_pending_task</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2afl0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2afl0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2afl0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afl0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2afl0q:0" aria-labelledby="tab:R2afl0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_queue_clear_pending_task <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R2afl0q:1" aria-labelledby="tab:R2afl0q: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:R2efl0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2efl0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2efl0q:0" aria-labelledby="tab:R2efl0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"restore_queue_clear_pending_task"</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/Restore-Queue-Reporting" data-section-id="tag/Restore-Queue-Reporting" 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/Restore-Queue-Reporting" aria-label="tag/Restore-Queue-Reporting"></a>Restore Queue Reporting</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Account Restoration / Restore Queue Reporting</p>
"><p>Account Restoration / Restore Queue Reporting</p>
</div></div></div><div id="tag/Restore-Queue-Reporting/operation/restore_queue_is_active" data-section-id="tag/Restore-Queue-Reporting/operation/restore_queue_is_active" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_queue_is_active" id="operation/restore_queue_is_active" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Queue-Reporting/operation/restore_queue_is_active" aria-label="tag/Restore-Queue-Reporting/operation/restore_queue_is_active"></a>Validate restoration queue is active<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks whether the system&#39;s restoration queue is actively processing tasks.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the system's restoration queue is actively processing tasks.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/restore_queue_is_active</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_queue_is_active</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9n0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9n0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9n0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9n0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9n0q:0" aria-labelledby="tab:R2a9n0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_queue_is_active
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9n0q:1" aria-labelledby="tab:R2a9n0q: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:R2e9n0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9n0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9n0q:0" aria-labelledby="tab:R2e9n0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_active"</span>: <span class="token number">1</span></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">"command"</span>: <span class="token string">"restore_queue_is_active"</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/Restore-Queue-Reporting/operation/restore_queue_list_active" data-section-id="tag/Restore-Queue-Reporting/operation/restore_queue_list_active" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_queue_list_active" id="operation/restore_queue_list_active" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Queue-Reporting/operation/restore_queue_list_active" aria-label="tag/Restore-Queue-Reporting/operation/restore_queue_list_active"></a>Return active restoration tasks list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the tasks that the restoration queue is actively processing.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the tasks that the restoration queue is actively processing.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/restore_queue_list_active</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_queue_list_active</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aan0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aan0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aan0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aan0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aan0q:0" aria-labelledby="tab:R2aan0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_queue_list_active
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aan0q:1" aria-labelledby="tab:R2aan0q: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:R2ean0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ean0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ean0q:0" aria-labelledby="tab:R2ean0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_job"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="obj collapsible"><li><div class="hoverable "><span class="property token string">"destid"</span>: <span class="token string">"local"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"give_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_config"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subdomains"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restore_point"</span>: <span class="token string">"2019-10-21T00:00:00.000Z"</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></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">"command"</span>: <span class="token string">"restore_queue_list_active"</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/Restore-Queue-Reporting/operation/restore_queue_list_completed" data-section-id="tag/Restore-Queue-Reporting/operation/restore_queue_list_completed" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_queue_list_completed" id="operation/restore_queue_list_completed" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Queue-Reporting/operation/restore_queue_list_completed" aria-label="tag/Restore-Queue-Reporting/operation/restore_queue_list_completed"></a>Return completed restoration tasks list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the restoration queue&#39;s completed tasks.</p>
<p><strong>Important:</strong></p>
<p>This function&#39;s output varies dramatically. The <a href="https://go.cpanel.net/backuprestoremanagerscript"><code>/usr/local/cpanel/bin/backup_restore_manager</code></a> script run with the <code>list_finished</code> option determines this output..</p>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of SPF resource records on DNS.</p>
<ul>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because <a href="https://tools.ietf.org/html/rfc7208">RFC 7208</a> deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the <a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the restoration queue's completed tasks.</p>
<p><strong>Important:</strong></p>
<p>This function's output varies dramatically. The <a href="https://go.cpanel.net/backuprestoremanagerscript"><code>/usr/local/cpanel/bin/backup_restore_manager</code></a> script run with the <code>list_finished</code> option determines this output..</p>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of SPF resource records on DNS.</p>
<ul>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because <a href="https://tools.ietf.org/html/rfc7208">RFC 7208</a> deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the <a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/restore_queue_list_completed</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_queue_list_completed</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abn0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abn0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abn0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abn0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abn0q:0" aria-labelledby="tab:R2abn0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_queue_list_completed
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abn0q:1" aria-labelledby="tab:R2abn0q: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:R2ebn0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebn0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebn0q:0" aria-labelledby="tab:R2ebn0q:0"><div><div class="sc-Rjrgp dIDLbO"><span 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="restore_queue_add_task_function" selected="">restore_queue_add_task_function</option><option value="restorepkg">restorepkg</option></select><label>restore_queue_add_task_function</label></div></div><div><div html="<p>A task that the restore_queue_add_task function added.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>A task that the restore_queue_add_task function added.</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">"restore_job"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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_job"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="obj collapsible"><li><div class="hoverable "><span class="property token string">"destid"</span>: <span class="token string">"local"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"give_ip"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mail_config"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subdomains"</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">"restore_point"</span>: <span class="token string">"2020-03-29"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"mrfrog"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status_info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"altered_items"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dangerous_items"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"finished"</span>: <span class="token string">"1586188203"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log"</span>: <span class="token string">"warning"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restore_logfile"</span>: <span class="token string">"item-RESTORE_AccountLocal_mrfrog"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"skipped_items"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"started"</span>: <span class="token string">"1586188078"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"statusmsg"</span>: <span class="token string">"warning"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"transfer_session_id"</span>: <span class="token string">"userbackup20200406154758JqBa"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</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">"metadata"</span>: <button class="collapser" aria-label="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">"restore_queue_list_completed"</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><div id="tag/Restore-Queue-Reporting/operation/restore_queue_state" data-section-id="tag/Restore-Queue-Reporting/operation/restore_queue_state" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_queue_state" id="operation/restore_queue_state" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Queue-Reporting/operation/restore_queue_state" aria-label="tag/Restore-Queue-Reporting/operation/restore_queue_state"></a>Return restoration tasks list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the tasks in the restoration queue.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the tasks in the restoration 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/restore_queue_state</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_queue_state</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acn0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acn0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acn0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acn0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acn0q:0" aria-labelledby="tab:R2acn0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_queue_state
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acn0q:1" aria-labelledby="tab:R2acn0q: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:R2ecn0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecn0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecn0q:0" aria-labelledby="tab:R2ecn0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="obj collapsible"><li><div class="hoverable "><span class="property token string">"give_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_config"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subdomains"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restore_point"</span>: <span class="token string">"2019-10-21T00:00:00.000Z"</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">"completed"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="obj collapsible"><li><div class="hoverable "><span class="property token string">"give_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_config"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subdomains"</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">"restore_point"</span>: <span class="token string">"2019-10-22T00:00:00.000Z"</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">"is_active"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pending"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="obj collapsible"><li><div class="hoverable "><span class="property token string">"give_ip"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mail_config"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subdomains"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restore_point"</span>: <span class="token string">"2019-10-23T00:00:00.000Z"</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></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">"command"</span>: <span class="token string">"restore_queue_state"</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/Restore-Queue-Reporting/operation/restore_queue_list_pending" data-section-id="tag/Restore-Queue-Reporting/operation/restore_queue_list_pending" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_queue_list_pending" id="operation/restore_queue_list_pending" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Queue-Reporting/operation/restore_queue_list_pending" aria-label="tag/Restore-Queue-Reporting/operation/restore_queue_list_pending"></a>Return pending restoration tasks list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the tasks that the restoration queue has not yet processed.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the tasks that the restoration queue has not yet 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/restore_queue_list_pending</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_queue_list_pending</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adn0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adn0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adn0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adn0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adn0q:0" aria-labelledby="tab:R2adn0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_queue_list_pending
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adn0q:1" aria-labelledby="tab:R2adn0q: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:R2edn0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edn0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edn0q:0" aria-labelledby="tab:R2edn0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_job"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="obj collapsible"><li><div class="hoverable "><span class="property token string">"destid"</span>: <span class="token string">"LmTZCUpqqLSPH8AO7pVtIeNK"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"give_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_config"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subdomains"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restore_point"</span>: <span class="token string">"2015-10-21T00:00:00.000Z"</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></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">"command"</span>: <span class="token string">"restore_queue_list_pending"</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/Restore-Queue-Reporting/operation/restore_modules_summary" data-section-id="tag/Restore-Queue-Reporting/operation/restore_modules_summary" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_modules_summary" id="operation/restore_modules_summary" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Restore-Queue-Reporting/operation/restore_modules_summary" aria-label="tag/Restore-Queue-Reporting/operation/restore_modules_summary"></a>Return backup modules list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists backup modules and their descriptions.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists backup modules and their descriptions.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/restore_modules_summary</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_modules_summary</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aen0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aen0q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aen0q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aen0q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aen0q:0" aria-labelledby="tab:R2aen0q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_modules_summary
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aen0q:1" aria-labelledby="tab:R2aen0q: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:R2een0q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2een0q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2een0q:0" aria-labelledby="tab:R2een0q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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 "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"APITokens"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 APITokens module restores the API tokens for an account."</span></div></li></ul><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">"module"</span>: <span class="token string">"Account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_summary"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"Force mode is not available in restricted mode."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 creates the cPanel account and system user."</span></div></li></ul><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">"module"</span>: <span class="token string">"AuthnLinks"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores the account’s external authentication links."</span></div></li></ul><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">"module"</span>: <span class="token string">"AutoSSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores AutoSSL settings."</span></div></li></ul><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">"module"</span>: <span class="token string">"BackupConfig"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 installs the backup configuration based on the target system’s defaults."</span></div></li></ul><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">"module"</span>: <span class="token string">"BandwidthData"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores the bandwidth data."</span></div></li></ul><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">"module"</span>: <span class="token string">"CpUser"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_summary"</span>: <button class="collapser" aria-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 discards configuration data that is unknown or that the system cannot validate."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores the cPanel account’s configuration data."</span></div></li></ul><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">"module"</span>: <span class="token string">"Cron"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores crontab entries."</span></div></li></ul><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">"module"</span>: <span class="token string">"CustomLocale"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores custom locales."</span></div></li></ul><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">"module"</span>: <span class="token string">"DKIM"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores DKIM (DomainKeys Identified Mail) keys and updates records for the current server."</span></div></li></ul><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">"module"</span>: <span class="token string">"DNSAuthority"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 module reports whether this system is authoritative for each of the new accounts’ DNS (Domain Name System) zones."</span></div></li></ul><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">"module"</span>: <span class="token string">"DNSSEC"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 module restores the DNSSEC keys for an account."</span></div></li></ul><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">"module"</span>: <span class="token string">"DigestShadow"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores password data for digest authentication."</span></div></li></ul><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">"module"</span>: <span class="token string">"Domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_summary"</span>: <button class="collapser" aria-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 will restore subdomains, parked domains, and addon domains if they pass the server’s domain creation rules. If the server rejects the restoration of an addon domain, it will still create a subdomain associated with that addon domain."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores subdomains, parked domains, and addon domains."</span></div></li></ul><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">"module"</span>: <span class="token string">"FeatureList"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores the account’s feature list setting."</span></div></li></ul><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">"module"</span>: <span class="token string">"FileProtect"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 configures the account for cPanel FileProtect."</span></div></li></ul><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">"module"</span>: <span class="token string">"Ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores FTP (File Transfer Protocol) accounts."</span></div></li></ul><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">"module"</span>: <span class="token string">"Homedir"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_summary"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"If the home directory does not already exist, the system will not create it."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores the home directory’s contents."</span></div></li></ul><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">"module"</span>: <span class="token string">"Htaccess"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 repairs EasyApache4 and removes legacy Frontpage entries from .htaccess."</span></div></li></ul><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">"module"</span>: <span class="token string">"IPAddress"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 sets up a dedicated IP address."</span></div></li></ul><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">"module"</span>: <span class="token string">"Integration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"Implementor Error: The summary for this module is missing."</span></div></li></ul><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">"module"</span>: <span class="token string">"LinkedNodes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 module handles the linked node setup."</span></div></li></ul><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">"module"</span>: <span class="token string">"LinkedNodesSubarchives"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 module restores linked-node configurations when the archive contains linked node data."</span></div></li></ul><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">"module"</span>: <span class="token string">"LocalConfig"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 module updates the local user’s configuration."</span></div></li></ul><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">"module"</span>: <span class="token string">"Logs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores service access logs."</span></div></li></ul><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">"module"</span>: <span class="token string">"Mail"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 resets email quotas to safe values and restores email aliases, filters and mail items."</span></div></li></ul><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">"module"</span>: <span class="token string">"MailFix"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 repairs mail permissions and upgrades the system to the latest storage methods."</span></div></li></ul><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">"module"</span>: <span class="token string">"MailLimits"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores any holds or suspensions on outgoing messages for a user’s email accounts."</span></div></li></ul><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">"module"</span>: <span class="token string">"MailRouting"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 updates MX (Mail eXchange) records."</span></div></li></ul><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">"module"</span>: <span class="token string">"MailSync"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 copies any new mail to the local server that the remote account received during the transfer."</span></div></li></ul><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">"module"</span>: <span class="token string">"Mailman"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores mailing lists."</span></div></li></ul><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">"module"</span>: <span class="token string">"ManualMX"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 configures the source server’s manual MX entries to send mail to the destination server."</span></div></li></ul><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">"module"</span>: <span class="token string">"Mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores MariaDB/MySQL databases, users, and grants."</span></div></li></ul><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">"module"</span>: <span class="token string">"MysqlRemoteNotes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 MysqlRemoteNotes module restores the Remote MySQL comments for an account."</span></div></li></ul><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">"module"</span>: <span class="token string">"NobodyFiles"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores ownership of files previously owned by the “nobody” user in the home directory."</span></div></li></ul><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">"module"</span>: <span class="token string">"OldHomedirs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"Symbolic links for former home directories ensure that applications with hard-coded paths continue to work when transferred between servers."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 creates symbolic links to former home directory paths."</span></div></li></ul><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">"module"</span>: <span class="token string">"Package"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"If the target server does not have the package that the user has been assigned, the system will use the account’s properties to recreate the package."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 recreates account packages."</span></div></li></ul><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">"module"</span>: <span class="token string">"Password"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores the encrypted system password."</span></div></li></ul><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">"module"</span>: <span class="token string">"PostRestoreActions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notes"</span>: <button class="collapser" aria-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 module updates system databases and name server IP address lists, restarts services, unblocks dynamic content, and runs custom post-restoration scripts."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 runs post-restoration actions and cleanups."</span></div></li></ul><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">"module"</span>: <span class="token string">"Postgres"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_summary"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"PostgreSQL version “8.4” or later is required to restore databases in restricted mode."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores PostgreSQL databases, users, and grants."</span></div></li></ul><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">"module"</span>: <span class="token string">"PreRestoreActions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notes"</span>: <button class="collapser" aria-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 module temporarily lifts the account’s quota and runs custom pre-restoration scripts."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 performs pre-restoration actions and cleanups."</span></div></li></ul><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">"module"</span>: <span class="token string">"ProxySubdomains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notes"</span>: <button class="collapser" aria-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 module ensures that service subdomains such as “cpanel”, “cpcalendars”, and “cpcontacts” are configured properly."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores service subdomains."</span></div></li></ul><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">"module"</span>: <span class="token string">"PublicContact"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores the account’s public contact data."</span></div></li></ul><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">"module"</span>: <span class="token string">"PublicHtmlSymlinks"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"Symbolic links for former web root directories ensure that applications with hard-coded paths will continue to work when transferred between servers."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_summary"</span>: <button class="collapser" aria-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 does not recreate symbolic links outside of the account’s home directory in restricted mode."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 creates symbolic links to former web root directory paths."</span></div></li></ul><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">"module"</span>: <span class="token string">"PublishZones"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 module ensures all zones have been synced out and reloaded across the DNS (Domain Name System) cluster."</span></div></li></ul><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">"module"</span>: <span class="token string">"Quota"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores the account’s data storage quota."</span></div></li></ul><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">"module"</span>: <span class="token string">"Reseller"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notes"</span>: <button class="collapser" aria-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 restores all of the privileges the account previously had. This includes the “all” privilege, which is equivalent to root access."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores reseller privileges."</span></div></li></ul><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">"module"</span>: <span class="token string">"ResyncHomedir"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_summary"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"If the home directory does not already exist, the system will not create it."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 module will resynchronize the home directory from the source server. The module preserves any changes that occurred during the transfer."</span></div></li></ul><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">"module"</span>: <span class="token string">"Roundcube"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores Roundcube configuration and preferences."</span></div></li></ul><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">"module"</span>: <span class="token string">"SPF"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores SPF (Sender Policy Framework) records and updates them for the target server."</span></div></li></ul><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">"module"</span>: <span class="token string">"SSL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores SSL (Secure Sockets Layer) keys, certificates, and virtual host entries."</span></div></li></ul><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">"module"</span>: <span class="token string">"ServiceProxy"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 module sets up applicable service proxying to the destination servers."</span></div></li></ul><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">"module"</span>: <span class="token string">"Shell"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_summary"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"In restricted mode, the system will set any account that requests a shell other than “noshell” or “jailshell” to use “jailshell”."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores the account’s shell."</span></div></li></ul><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">"module"</span>: <span class="token string">"SpamAssassin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 module will disable SpamAssassin for the restored user if they had it enabled at the source."</span></div></li></ul><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">"module"</span>: <span class="token string">"Subaccount"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"Implementor Error: The summary for this module is missing."</span></div></li></ul><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">"module"</span>: <span class="token string">"Suspend"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_summary"</span>: <button class="collapser" aria-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 will not restore the suspension reason or old shell for the account and instead will use a default."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 module will suspend the restored user if they were suspended at the source."</span></div></li></ul><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">"module"</span>: <span class="token string">"Unsuspend"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 unsuspends .htaccess files."</span></div></li></ul><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">"module"</span>: <span class="token string">"VhostIncludes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores custom virtual host includes."</span></div></li></ul><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">"module"</span>: <span class="token string">"Vhosts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 module installs the web server configuration and restarts the web server."</span></div></li></ul><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">"module"</span>: <span class="token string">"WebCalls"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 module restores the account’s web call data."</span></div></li></ul><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">"module"</span>: <span class="token string">"WebDiskHomedir"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 rewrites web disk home directories to the correct location on the new server."</span></div></li></ul><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">"module"</span>: <span class="token string">"ZoneFile"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <button class="collapser" aria-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 restores custom DNS (Domain Name System) Zone entries."</span></div></li></ul><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">"module"</span>: <span class="token string">"userdata"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restricted_summary"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"Restricted Restore does not restore the entire userdata file; instead, the system will create a new one and copy in certain information. Customizations to the userdata file in the archive will not be in the newly-created userdata 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">"summary"</span>: <button class="collapser" aria-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 restores website configuration (userdata)."</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">"metadata"</span>: <button class="collapser" aria-label="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">"restore_modules_summary"</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/Account-Creation" data-section-id="tag/Account-Creation" 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-Creation" aria-label="tag/Account-Creation"></a>Account Creation</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Accounts / Account Creation</p>
"><p>Accounts / Account Creation</p>
</div></div></div><div id="tag/Account-Creation/operation/verify_new_username" data-section-id="tag/Account-Creation/operation/verify_new_username" class="sc-dntaoT ceciOs"><div data-section-id="operation/verify_new_username" id="operation/verify_new_username" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Creation/operation/verify_new_username" aria-label="tag/Account-Creation/operation/verify_new_username"></a>Validate new cPanel account username<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks for username conflicts during account creation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks for username conflicts during account creation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=username</span></div><div><div html="<p>The account that you wish to create.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account that you wish to create.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/verify_new_username</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/verify_new_username</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99631a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99631a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99631a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99631a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99631a:0" aria-labelledby="tab:R99631a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
verify_new_username <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R99631a:1" aria-labelledby="tab:R99631a: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:R9p631a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p631a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p631a:0" aria-labelledby="tab:R9p631a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"verify_new_username"</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/Account-Creation/operation/get_current_users_count" data-section-id="tag/Account-Creation/operation/get_current_users_count" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_current_users_count" id="operation/get_current_users_count" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Creation/operation/get_current_users_count" aria-label="tag/Account-Creation/operation/get_current_users_count"></a>Return cPanel accounts total number<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the number of cPanel accounts on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the number of cPanel accounts on the 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_current_users_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_current_users_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:R99a31a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99a31a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99a31a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99a31a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99a31a:0" aria-labelledby="tab:R99a31a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_current_users_count
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99a31a:1" aria-labelledby="tab:R99a31a: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:R9pa31a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pa31a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pa31a:0" aria-labelledby="tab:R9pa31a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"users"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_current_users_count"</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/Account-Creation/operation/get_maximum_users" data-section-id="tag/Account-Creation/operation/get_maximum_users" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_maximum_users" id="operation/get_maximum_users" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Creation/operation/get_maximum_users" aria-label="tag/Account-Creation/operation/get_maximum_users"></a>Return maximum accounts for license<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the maximum number of cPanel accounts that the server&#39;s license allows.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the maximum number of cPanel accounts that the server's license allows.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_maximum_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_maximum_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:R99e31a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99e31a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99e31a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99e31a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99e31a:0" aria-labelledby="tab:R99e31a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_maximum_users
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99e31a:1" aria-labelledby="tab:R99e31a: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:R9pe31a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pe31a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pe31a:0" aria-labelledby="tab:R9pe31a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"users"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_maximum_users"</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/Account-Creation/operation/createacct" data-section-id="tag/Account-Creation/operation/createacct" class="sc-dntaoT ceciOs"><div data-section-id="operation/createacct" id="operation/createacct" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Creation/operation/createacct" aria-label="tag/Account-Creation/operation/createacct"></a>Create cPanel account<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates a cPanel account and sets up its domain information.</p>
<p><strong>Note:</strong></p>
<ul>
<li>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of SPF resource records on DNS.</li>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because <a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>. CentOS 7 servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the <a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a cPanel account and sets up its domain information.</p>
<p><strong>Note:</strong></p>
<ul>
<li>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of SPF resource records on DNS.</li>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because <a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>. CentOS 7 servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the <a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</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_enhancements" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand account_enhancements"><span class="property-name">account_enhancements</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 Array of strings</span></div> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account_enhancements=My Custom Enhancement&account_enhancements=Sample Enhancement</span> -<!-- --> <!-- -->Assign multiple enhancements</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account_enhancements=My Custom Enhancement</span> -<!-- --> <!-- -->Assign one enhancement</li></ul><div><div html="<p>Assign <a href="https://go.cpanel.net/account-enhancements">Account Enhancements</a> to the cPanel account. To view your server&#39;s Account Enhancements, run WHM API 1&#39;s <code>list_account_enhancements</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Assign <a href="https://go.cpanel.net/account-enhancements">Account Enhancements</a> to the cPanel account. To view your server's Account Enhancements, run WHM API 1's <code>list_account_enhancements</code> function.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="bwlimit" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand bwlimit"><span class="property-name">bwlimit</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->megabytes<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">bwlimit=unlimited</span></div><div><div html="<p>The account&#39;s maximum bandwidth.</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The account possesses unlimited bandwidth.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's maximum bandwidth.</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The account possesses unlimited bandwidth.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="cgi" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cgi</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cgi=1</span></div><div><div html="<p>Whether the account has <a href="https://en.wikipedia.org/wiki/Common_Gateway_Interface">Common Gateway Interface (CGI)</a> access enabled.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<p> When a <a href="https://docs.cpanel.net/whm/server-configuration/server-profile/">server profile</a> disables the <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/86/">Web Server</a> role, this parameter defaults to <code>0</code>. On these servers, you <strong>cannot</strong> enable CGI access.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the account has <a href="https://en.wikipedia.org/wiki/Common_Gateway_Interface">Common Gateway Interface (CGI)</a> access enabled.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<p> When a <a href="https://docs.cpanel.net/whm/server-configuration/server-profile/">server profile</a> disables the <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/86/">Web Server</a> role, this parameter defaults to <code>0</code>. On these servers, you <strong>cannot</strong> enable CGI access.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="contactemail" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">contactemail</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">contactemail=username@example.com</span></div><div><div html="<p>The account&#39;s contact email address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's contact email address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="cpmod" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpmod</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cpmod=jupiter</span></div><div><div html="<p>The account&#39;s cPanel theme.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the server&#39;s <a href="https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup/">default cPanel theme</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's cPanel theme.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the server's <a href="https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup/">default cPanel theme</a>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="customip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">customip</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">customip=192.0.2.0</span></div><div><div html="<p>The account&#39;s IP address.</p>
<p><strong>Note:</strong></p>
<p>If you do not specify this parameter, the system will determine the account&#39;s IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's IP address.</p>
<p><strong>Note:</strong></p>
<p>If you do not specify this parameter, the system will determine the account's IP address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="dkim" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dkim</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">dkim=1</span></div><div><div html="<p>Whether <a href="https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail">DomainKeys Identified Mail (DKIM)</a> is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the <em>Enable DKIM on domains for newly created accounts</em> setting&#39;s value in WHM&#39;s <em><a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/">Tweak Settings</a> interface (WHM &gt;&gt; Home &gt;&gt; System Configuration &gt;&gt; Tweak Settings)</em>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether <a href="https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail">DomainKeys Identified Mail (DKIM)</a> is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the <em>Enable DKIM on domains for newly created accounts</em> setting's value in WHM's <em><a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/">Tweak Settings</a> interface (WHM >> Home >> System Configuration >> Tweak Settings)</em>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="dmarc" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dmarc</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">dmarc=1</span></div><div><div html="<p>Whether <a href="https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-glossary/#dmarc">Domain-based Message Authentication, Reporting, and Conformance (DMARC)</a> is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the <em>Enable DMARC on domains for newly created accounts</em> setting&#39;s value in the <em>Domains</em> section of WHM&#39;s <em><a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/#domains">Tweak Settings</a> interface (WHM &gt;&gt; Home &gt;&gt; System Configuration &gt;&gt; Tweak Settings)</em>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether <a href="https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-glossary/#dmarc">Domain-based Message Authentication, Reporting, and Conformance (DMARC)</a> is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the <em>Enable DMARC on domains for newly created accounts</em> setting's value in the <em>Domains</em> section of WHM's <em><a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/#domains">Tweak Settings</a> interface (WHM >> Home >> System Configuration >> Tweak Settings)</em>.</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></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 main domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's main domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="featurelist" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">featurelist</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"default"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">featurelist=feature_list</span></div><div><div html="<p>The account&#39;s assigned feature list.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's assigned feature list.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="forcedns" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">forcedns</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">forcedns=0</span></div><div><div html="<p>Whether to overwrite an existing DNS zone with the new account&#39;s information. The system performs this action if a matching DNS zone currently exists.</p>
<ul>
<li><code>1</code> — Overwrite.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to overwrite an existing DNS zone with the new account's information. The system performs this action if a matching DNS zone currently exists.</p>
<ul>
<li><code>1</code> — Overwrite.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite.</li>
</ul>
</div></div></div></td></tr><tr class=""><td class="sc-ovuCP sc-eauhAA dEkioI iQpMVv deprecated" kind="field" title="frontpage"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">frontpage</span></td><td 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 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">null</span></div> <div><div html="<p>Whether the account has Microsoft® FrontPage Extensions enabled.</p>
<p><strong>Note:</strong></p>
<p> cPanel &amp; WHM ignores all FrontPage settings and parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the account has Microsoft® FrontPage Extensions enabled.</p>
<p><strong>Note:</strong></p>
<p> cPanel & WHM ignores all FrontPage settings and parameters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="gid" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">gid</span></td><td class="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">gid=123456789</span></div><div><div html="<p>The account&#39;s group ID.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To use this parameter, the function&#39;s caller <strong>must</strong> authenticate as the root user.</li>
<li>If you do <strong>not</strong> specify this parameter, the system generates a group ID.</li>
<li>This <strong>must</strong> be a unique value that is <strong>not</strong> currently associated with disk usage and does <strong>not</strong> exist on the server.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's group ID.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To use this parameter, the function's caller <strong>must</strong> authenticate as the root user.</li>
<li>If you do <strong>not</strong> specify this parameter, the system generates a group ID.</li>
<li>This <strong>must</strong> be a unique value that is <strong>not</strong> currently associated with disk usage and does <strong>not</strong> exist on the server.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="hasshell" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">hasshell</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">hasshell=0</span></div><div><div html="<p>Whether the account has shell (SSH) access enabled.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the account has shell (SSH) access enabled.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="hasuseregns" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">hasuseregns</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">hasuseregns=1</span></div><div><div html="<p>A legacy parameter.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p><strong>Important:</strong></p>
<p> Only include this parameter if you set a useregns value of 1.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A legacy parameter.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p><strong>Important:</strong></p>
<p> Only include this parameter if you set a useregns value of 1.</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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">homedir=/home/user</span></div><div><div html="<p>The absolute path to the account&#39;s <code>home</code> directory.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To use this parameter, the function&#39;s caller <strong>must</strong> authenticate as the <code>root</code> user.</li>
<li>If you do not specify a value, the system uses the <code>/home/user</code> directory, where <code>user</code> is the account&#39;s username.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute path to the account's <code>home</code> directory.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To use this parameter, the function's caller <strong>must</strong> authenticate as the <code>root</code> user.</li>
<li>If you do not specify a value, the system uses the <code>/home/user</code> directory, where <code>user</code> is the account's username.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"n"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"y"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"n"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=n</span></div><div><div html="<p>Whether the account has a dedicated IP address.</p>
<ul>
<li><code>y</code> — The account possesses a dedicated IP address.</li>
<li><code>n</code> — The account does <strong>not</strong> possess a dedicated IP address.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the account has a dedicated IP address.</p>
<ul>
<li><code>y</code> — The account possesses a dedicated IP address.</li>
<li><code>n</code> — The account does <strong>not</strong> possess a dedicated IP address.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="language" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">language</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">language=en</span></div><div><div html="<p>The account&#39;s default locale.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This value is case-sensitive.</li>
<li>For region-specific locales, use the ISO 639-1 code, an underscore (<code>_</code>), and the <a href="https://en.wikipedia.org/wiki/ISO_3166-1">ISO 3166-1</a> code.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's default locale.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This value is case-sensitive.</li>
<li>For region-specific locales, use the ISO 639-1 code, an underscore (<code>_</code>), and the <a href="https://en.wikipedia.org/wiki/ISO_3166-1">ISO 3166-1</a> code.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="mail_node_alias" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mail_node_alias</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mail_node_alias=mailnode</span></div><div><div html="<p>A <a href="https://docs.cpanel.net/whm/server-configuration/link-server-nodes/">linked cPanel mail server</a> on which to also create the account. This is the server&#39;s alias (friendly name) defined when creating the link to a cPanel mail server.</p>
<p><strong>Note:</strong></p>
<p> This function <strong>requires</strong> a linked cPanel mail server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A <a href="https://docs.cpanel.net/whm/server-configuration/link-server-nodes/">linked cPanel mail server</a> on which to also create the account. This is the server's alias (friendly name) defined when creating the link to a cPanel mail server.</p>
<p><strong>Note:</strong></p>
<p> This function <strong>requires</strong> a linked cPanel mail server.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="mailbox_format" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mailbox_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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mdbox"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"maildir"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mailbox_format=mdbox</span></div><div><div html="<p>A mailbox format to use, if you do not wish to use the system&#39;s default mailbox format.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Use this parameter when you transfer between servers with different mailbox formats.</li>
<li>This parameter defaults to the <em>The mailbox storage format for new accounts setting</em> in the <em>Mail</em> section of WHM&#39;s <a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/#mail"><em>Tweak Settings</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>).</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A mailbox format to use, if you do not wish to use the system's default mailbox format.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Use this parameter when you transfer between servers with different mailbox formats.</li>
<li>This parameter defaults to the <em>The mailbox storage format for new accounts setting</em> in the <em>Mail</em> section of WHM's <a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/#mail"><em>Tweak Settings</em></a> interface (<em>WHM >> Home >> Server Configuration >> Tweak Settings</em>).</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_defer_fail_percentage" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand max_defer_fail_percentage"><span class="property-name">max_defer_fail_percentage</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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">"unlimited"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">max_defer_fail_percentage=unlimited</span></div><div><div html="<p>The percentage of failed or deferred email messages that the account can send per hour. If the account exceeds this value its outgoing mail is rate-limited.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The account can send an unlimited number of failed or deferred messages.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The percentage of failed or deferred email messages that the account can send per hour. If the account exceeds this value its outgoing mail is rate-limited.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The account can send an unlimited number of failed or deferred messages.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_email_per_hour" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand max_email_per_hour"><span class="property-name">max_email_per_hour</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">max_email_per_hour=unlimited</span></div><div><div html="<p>The maximum number of emails that the account can send in one hour.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The account can send an unlimited number of emails.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of emails that the account can send in one hour.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The account can send an unlimited number of emails.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_emailacct_quota" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand max_emailacct_quota"><span class="property-name">max_emailacct_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><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->megabytes<!-- -->><!-- --> </span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1024</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">max_emailacct_quota=1024</span></div><div><div html="<p>The maximum size that the account can define when it creates an email account.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The account possesses an unlimited quota.</li>
</ul>
<p><strong>Important:</strong></p>
<ul>
<li>This value applies to each email account, <strong>not</strong> each cPanel account.</li>
<li>If you define this parameter it overwrites the hosting plan&#39;s defined value for the account.</li>
<li>We recommend that you allow the account&#39;s plan to determine this value.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum size that the account can define when it creates an email account.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The account possesses an unlimited quota.</li>
</ul>
<p><strong>Important:</strong></p>
<ul>
<li>This value applies to each email account, <strong>not</strong> each cPanel account.</li>
<li>If you define this parameter it overwrites the hosting plan's defined value for the account.</li>
<li>We recommend that you allow the account's plan to determine this value.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_team_users" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">max_team_users</span></td><td class="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 .. 7 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">max_team_users=7</span></div><div><div html="<p>The maximum number of Team users for this account.
This parameter should be a number between 0 and the server&#39;s default value, inclusively.
This parameter can not be a number greater than the server&#39;s default value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of Team users for this account.
This parameter should be a number between 0 and the server's default value, inclusively.
This parameter can not be a number greater than the server's default value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxaddon" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxaddon"><span class="property-name">maxaddon</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or 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">maxaddon=unlimited</span></div><div><div html="<p>The account&#39;s maximum number of addon domains.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The account possesses unlimited addon domains.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's maximum number of addon domains.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The account possesses unlimited addon domains.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxftp" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxftp"><span class="property-name">maxftp</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">maxftp=unlimited</span></div><div><div html="<p>The account&#39;s maximum number of FTP accounts.</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The account possesses unlimited FTP accounts.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's maximum number of FTP accounts.</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The account possesses unlimited FTP accounts.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxlst" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxlst"><span class="property-name">maxlst</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">maxlst=unlimited</span></div><div><div html="<p>The account&#39;s maximum number of mailing lists.</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The account possesses unlimited mailing lists.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's maximum number of mailing lists.</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The account possesses unlimited mailing lists.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxpark" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxpark"><span class="property-name">maxpark</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or 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">maxpark=unlimited</span></div><div><div html="<p>The account&#39;s maximum number of parked domains (aliases).</p>
<ul>
<li><code>unlimited</code> or <code>null</code> — The account possesses unlimited parked domains.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's maximum number of parked domains (aliases).</p>
<ul>
<li><code>unlimited</code> or <code>null</code> — The account possesses unlimited parked domains.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxpop" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxpop"><span class="property-name">maxpop</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">maxpop=unlimited</span></div><div><div html="<p>The account&#39;s maximum number of email accounts.</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The account possesses unlimited email accounts.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's maximum number of email accounts.</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The account possesses unlimited email accounts.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxsql" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxsql"><span class="property-name">maxsql</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">maxsql=unlimited</span></div><div><div html="<p>The account&#39;s maximum number of each available type of SQL database.
For example, this parameter has a <code>5</code> value and the system administrator allows
MySQL® and PostgreSQL® databases. Users can create up to five MySQL databases
and up to five PostgreSQL databases.</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The account possesses unlimited databases.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's maximum number of each available type of SQL database.
For example, this parameter has a <code>5</code> value and the system administrator allows
MySQL® and PostgreSQL® databases. Users can create up to five MySQL databases
and up to five PostgreSQL databases.</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The account possesses unlimited databases.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxsub" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxsub"><span class="property-name">maxsub</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">maxsub=unlimited</span></div><div><div html="<p>The account&#39;s maximum number of subdomains.
<code>unlimited</code> or <code>null</code> — The account possesses unlimited subdomains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's maximum number of subdomains.
<code>unlimited</code> or <code>null</code> — The account possesses unlimited subdomains.</p>
</div></div></div></td></tr><tr class=""><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">"local"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</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> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"auto"</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 account&#39;s main mail exchanger&#39;s type.</p>
<ul>
<li><code>local</code> - Local Mail Exchanger.</li>
<li><code>secondary</code> - Backup Mail Exchanger.</li>
<li><code>remote</code> - Remote Mail Exchanger.</li>
<li><code>auto</code> - Automatically Detect Configuration.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The function does <strong>not</strong> configure the primary MX entry to point to the appropriate exchanger. You must <a href="https://docs.cpanel.net/whm/dns-functions/email-routing-configuration/">perform this function separately</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's main mail exchanger's type.</p>
<ul>
<li><code>local</code> - Local Mail Exchanger.</li>
<li><code>secondary</code> - Backup Mail Exchanger.</li>
<li><code>remote</code> - Remote Mail Exchanger.</li>
<li><code>auto</code> - Automatically Detect Configuration.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The function does <strong>not</strong> configure the primary MX entry to point to the appropriate exchanger. You must <a href="https://docs.cpanel.net/whm/dns-functions/email-routing-configuration/">perform this function separately</a>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="owner" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">owner</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">owner=root</span></div><div><div html="<p>The name of the account owner.</p>
<ul>
<li><code>root</code></li>
<li>A valid reseller account username on the server.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the account owner.</p>
<ul>
<li><code>root</code></li>
<li>A valid reseller account username on the server.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="ownerself" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ownerself</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">ownerself=1</span></div><div><div html="<p>Set the account to own itself. Ignored if <code>owner</code> is set.</p>
<ul>
<li><code>1</code> — Set account to own itself.</li>
<li><code>0</code> — Do nothing.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Set the account to own itself. Ignored if <code>owner</code> is set.</p>
<ul>
<li><code>1</code> — Set account to own itself.</li>
<li><code>0</code> — Do nothing.</li>
</ul>
</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 account&#39;s password.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can use either the <code>pass</code> or the <code>password</code> parameter, but <strong>not</strong> both.</li>
<li>If you don&#39;t specify this value, the system generates a secure password.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's password.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can use either the <code>pass</code> or the <code>password</code> parameter, but <strong>not</strong> both.</li>
<li>If you don't specify this value, the system generates a secure password.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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 account&#39;s password.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can use <strong>either</strong> the <code>pass</code> or the <code>password</code> parameter, but <strong>not</strong> both.</li>
<li>If you don&#39;t specify this value, the system generates a secure password.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's password.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can use <strong>either</strong> the <code>pass</code> or the <code>password</code> parameter, but <strong>not</strong> both.</li>
<li>If you don't specify this value, the system generates a secure password.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="pkgname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">pkgname</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">pkgname=my_new_package</span></div><div><div html="<p>A new plan name. Use this parameter to save unique account settings as a new plan.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you do <strong>not</strong> use this parameter but specify <code>1</code> for the <code>savepkg</code> value, the system will generate a plan name.</li>
<li>If you do <strong>not</strong> use this parameter and specify <code>0</code> or do not use the <code>savepkg</code> parameter, the function does not save a new plan.</li>
<li>If you do <strong>not</strong> use this parameter, the function will not save the new account settings.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A new plan name. Use this parameter to save unique account settings as a new plan.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you do <strong>not</strong> use this parameter but specify <code>1</code> for the <code>savepkg</code> value, the system will generate a plan name.</li>
<li>If you do <strong>not</strong> use this parameter and specify <code>0</code> or do not use the <code>savepkg</code> parameter, the function does not save a new plan.</li>
<li>If you do <strong>not</strong> use this parameter, the function will not save the new account settings.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="plan" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">plan</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"default"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">plan=default</span></div><div><div html="<p>The account&#39;s hosting plan (package).</p>
<p><strong>Important:</strong></p>
<p> If you provide this value, <strong>do not</strong> use the optional quota-related parameters below. Instead, we recommend that you allow the account&#39;s plan to determine these values.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's hosting plan (package).</p>
<p><strong>Important:</strong></p>
<p> If you provide this value, <strong>do not</strong> use the optional quota-related parameters below. Instead, we recommend that you allow the account's plan to determine these values.</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 class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->megabytes<!-- -->><!-- --> </span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> <!-- -->[ 0 .. 999999 ]<!-- --> </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 account&#39;s disk space quota.</p>
<ul>
<li><code>0</code> — The account&#39;s disk space is unlimited.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's disk space quota.</p>
<ul>
<li><code>0</code> — The account's disk space is unlimited.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="reseller" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">reseller</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">reseller=0</span></div><div><div html="<p>Whether to grant reseller privileges to the account.</p>
<ul>
<li><code>1</code> — Grant reseller privileges.</li>
<li><code>0</code> — Do <strong>not</strong> grant reseller privileges.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to grant reseller privileges to the account.</p>
<ul>
<li><code>1</code> — Grant reseller privileges.</li>
<li><code>0</code> — Do <strong>not</strong> grant reseller privileges.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="reseller_without_domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">reseller_without_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">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">reseller_without_domain=0</span></div><div><div html="<p>Create the user as a reseller without an associated domain.</p>
<ul>
<li><code>1</code> - Create the account as a reseller without an associated domain.</li>
<li><code>0</code> - Do <strong>not</strong> create the account as a reseller without an associated domain.</li>
</ul>
<p><strong>Warning:</strong></p>
<p>If you create a reseller without a domain, certain parts of WHM will not function
for that user. These limitations exist both when logged in as that user <strong>and</strong>
when you attempt to perform actions which affect that user.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Create the user as a reseller without an associated domain.</p>
<ul>
<li><code>1</code> - Create the account as a reseller without an associated domain.</li>
<li><code>0</code> - Do <strong>not</strong> create the account as a reseller without an associated domain.</li>
</ul>
<p><strong>Warning:</strong></p>
<p>If you create a reseller without a domain, certain parts of WHM will not function
for that user. These limitations exist both when logged in as that user <strong>and</strong>
when you attempt to perform actions which affect that user.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="savepkg" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">savepkg</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">savepkg=1</span></div><div><div html="<p>Whether to save the account&#39;s settings as a new plan.</p>
<ul>
<li><code>1</code> — Save.</li>
<li><code>0</code> — Do <strong>not</strong> save.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to save the account's settings as a new plan.</p>
<ul>
<li><code>1</code> — Save.</li>
<li><code>0</code> — Do <strong>not</strong> save.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="showpass" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">showpass</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"y"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"y"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"n"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">showpass=n</span></div><div><div html="<p>Whether to display the account password in the output.</p>
<ul>
<li><code>y</code> — Display the account password in the output.</li>
<li><code>n</code> — Do NOT display the account password in the output.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to display the account password in the output.</p>
<ul>
<li><code>y</code> — Display the account password in the output.</li>
<li><code>n</code> — Do NOT display the account password in the output.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="spamassassin" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">spamassassin</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">spamassassin=1</span></div><div><div html="<p>Whether the account has Apache SpamAssassin™ enabled.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the account has Apache SpamAssassin™ enabled.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="spambox" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">spambox</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"y"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"y"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"n"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">spambox=y</span></div><div><div html="<p>Whether to enable spam box filtering for the account.</p>
<ul>
<li><code>y</code> - Enable spam box filtering.</li>
<li><code>n</code> - Disable spam box filtering.
<strong>Note:</strong></li>
</ul>
<p> You <strong>must</strong> enable Apache SpamAssassin™ to use the Spam Box feature.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable spam box filtering for the account.</p>
<ul>
<li><code>y</code> - Enable spam box filtering.</li>
<li><code>n</code> - Disable spam box filtering.
<strong>Note:</strong></li>
</ul>
<p> You <strong>must</strong> enable Apache SpamAssassin™ to use the Spam Box feature.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="spf" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">spf</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">spf=1</span></div><div><div html="<p>Whether <a href="https://en.wikipedia.org/wiki/Sender_Policy_Framework">Sender Policy Framework (SPF)</a> is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the <em>Enable SPF on domains for newly created accounts</em>
setting&#39;s value in WHM&#39;s <a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/"><em>Tweak Settings</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; System Configuration &gt;&gt; Tweak Settings</em>).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether <a href="https://en.wikipedia.org/wiki/Sender_Policy_Framework">Sender Policy Framework (SPF)</a> is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the <em>Enable SPF on domains for newly created accounts</em>
setting's value in WHM's <a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/"><em>Tweak Settings</em></a> interface (<em>WHM >> Home >> System Configuration >> Tweak Settings</em>).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="uid" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">uid</span></td><td class="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">uid=123456789</span></div><div><div html="<p>The account&#39;s user ID.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To use this parameter, the function&#39;s caller <strong>must</strong> authenticate as the <code>root</code> user.</li>
<li>If you do not specify this parameter, the system generates a user ID.</li>
<li>This <strong>must</strong> be a unique value that is <strong>not</strong> currently associated with disk usage and does <strong>not</strong> exist on the server.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's user ID.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To use this parameter, the function's caller <strong>must</strong> authenticate as the <code>root</code> user.</li>
<li>If you do not specify this parameter, the system generates a user ID.</li>
<li>This <strong>must</strong> be a unique value that is <strong>not</strong> currently associated with disk usage and does <strong>not</strong> exist on the server.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="useregns" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">useregns</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">useregns=0</span></div><div><div html="<p>Whether to use registered nameservers for the domain.</p>
<ul>
<li><code>1</code> - Use registered nameservers.</li>
<li><code>0</code> - Use the server&#39;s default nameservers.</li>
</ul>
<p><strong>Important:</strong></p>
<p> If you set this parameter to <code>1</code>, you must also include the <code>hasuseregns</code> parameter with a value of <code>1</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use registered nameservers for the domain.</p>
<ul>
<li><code>1</code> - Use registered nameservers.</li>
<li><code>0</code> - Use the server's default nameservers.</li>
</ul>
<p><strong>Important:</strong></p>
<p> If you set this parameter to <code>1</code>, you must also include the <code>hasuseregns</code> parameter with a value of <code>1</code>.</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"> <!-- --><= 16 characters<!-- --> </span></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 new account&#39;s username. cPanel usernames <strong>must</strong> adhere to the following criteria:</p>
<ul>
<li>The first eight characters of a username <strong>must</strong> be unique.</li>
<li>A username <strong>cannot</strong> begin with a number or the test string.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>Use the <code>Cpanel::Validate::Username</code> Perl module to validate usernames before you call this function. For more information, read the <code>/usr/local/cpanel/Cpanel/Validate/Username.pod</code> file.</li>
<li>The system will automatically convert this value to all lowercase letters.</li>
<li>MySQL&#39;s unique character limitations do <strong>not</strong> exist on servers that use MariaDB.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new account's username. cPanel usernames <strong>must</strong> adhere to the following criteria:</p>
<ul>
<li>The first eight characters of a username <strong>must</strong> be unique.</li>
<li>A username <strong>cannot</strong> begin with a number or the test string.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>Use the <code>Cpanel::Validate::Username</code> Perl module to validate usernames before you call this function. For more information, read the <code>/usr/local/cpanel/Cpanel/Validate/Username.pod</code> file.</li>
<li>The system will automatically convert this value to all lowercase letters.</li>
<li>MySQL's unique character limitations do <strong>not</strong> exist on servers that use MariaDB.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/createacct</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/createacct</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99i31a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99i31a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99i31a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99i31a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99i31a:0" aria-labelledby="tab:R99i31a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
createacct <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">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:R99i31a:1" aria-labelledby="tab:R99i31a: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:R9pi31a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pi31a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pi31a:0" aria-labelledby="tab:R9pi31a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"192.0.2.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameserver"</span>: <span class="token string">"ns1.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameserver2"</span>: <span class="token string">"ns2.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameserver3"</span>: <span class="token string">"ns3.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameserver4"</span>: <span class="token string">"ns4.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameservera"</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">"nameservera2"</span>: <span class="token string">"192.0.2.2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameservera3"</span>: <span class="token string">"192.0.2.3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameservera4"</span>: <span class="token string">"192.0.2.4"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameserverentry"</span>: <span class="token string">"dnsentry1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameserverentry2"</span>: <span class="token string">"dnsentry2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameserverentry3"</span>: <span class="token string">"dnsentry3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameserverentry4"</span>: <span class="token string">"dnsentry4"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"package"</span>: <span class="token string">"my_new_package"</span></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">"command"</span>: <span class="token string">"createacct"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"raw"</span>: <span class="token string">"Checking input data...Forced Dns is enabled.\\nValidating Username......Done\\nValidating IP......Done\\nValidating Contact Email......Done\\n...Done\\nValidating system setup......Done\\nChecking for database conflicts......Done\\nWWWAcct 12.6.0 (c) 2024 WebPros International, LLC...\\n\\n+===================================+\\n| New Account Info |\\n+===================================+\\n| Domain: example.com\\n| Ip: 192.0.2.0 (n)\\n| HasCgi: y\\n| UserName: username\\n| PassWord: 123456luggage\\n| CpanelMod: jupiter\\n| HomeRoot: /home\\n| Quota: 1 GB\\n| NameServer1: ns1.example.com\\n| NameServer2: ns2.example.com\\n| NameServer3:\\n| NameServer4:\\n| Contact Email: username@example.com\\n| Package: my_new_package\\n| Feature List: feature_list\\n| Language: en\\n+===================================+\\n...Done\\nCustom Account Data Provided: no\\nRunning pre creation script (/usr/local/cpanel/scripts/prewwwacct)......Done\\nAdding User...Removing Shell Access (n)\\nSuccess...Done\\nAdding Entries to userdata......Done\\nSetting up Mail & Local Domains...localdomains...valiases ...vdomainaliases ...vfilters ......Done\\nConfiguring DNS...Zone example.com has been successfully added\\n...Done\\nVerifying MX Records and Setting up Databases...Reconfiguring Mail Routing:\\nLOCAL MAIL EXCHANGER: This server will serve as a primary mail exchanger for example.com's mail.:\\n This configuration has been automatically detected based on your mx entries.\\n\\n...Done\\nSetting up Service Subdomains......Done\\nUpdating Authentication Databases......Done\\nSetting passwords......Done\\nUpdating the userdata cache......Done\\n\\nCreating bandwidth datastore......Done\\nUpdating the dedicated IP address usage cache......Done\\nGenerating and installing DKIM keys......Done\\nEnabling Apache SpamAssassin......Done\\nEnabling Apache SpamAssassin Spam Box......Done\\nSending Account Information......Done\\nRunning post creation scripts (/usr/local/cpanel/scripts/legacypostwwwacct, /usr/local/cpanel/scripts/postwwwacct, /usr/local/cpanel/scripts/postwwwacctuser)......Done\\nwwwacct creation finished\\nAccount Creation Complete!!!...Account Creation Ok...Done\\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">"reason"</span>: <span class="token string">"Account Creation 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/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 Enhancements module for WHM.</p>
"><p>The Account Enhancements module for WHM.</p>
</div></div></div><div id="tag/Account-Enhancements/operation/list_account_enhancements" data-section-id="tag/Account-Enhancements/operation/list_account_enhancements" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_account_enhancements" id="operation/list_account_enhancements" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Enhancements/operation/list_account_enhancements" aria-label="tag/Account-Enhancements/operation/list_account_enhancements"></a>Return Account Enhancements<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves all existing account enhancements on the system.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves all existing account enhancements on the system.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_account_enhancements</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_account_enhancements</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99651a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99651a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99651a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99651a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99651a:0" aria-labelledby="tab:R99651a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_account_enhancements
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99651a:1" aria-labelledby="tab:R99651a: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:R9p651a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p651a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p651a:0" aria-labelledby="tab:R9p651a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enhancements"</span>: <button class="collapser" aria-label="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">"metadata"</span>: <button class="collapser" aria-label="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">"list_account_enhancements"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"(XID svx4zp) The enhancement file “/var/cpanel/account_enhancements/enhancement 5000.json” contains an invalid enhancement “id”: “bad-id”."</span></div></li></ul><span class="token punctuation">]</span></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">"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/Account-Enhancements/operation/create_account_enhancement" data-section-id="tag/Account-Enhancements/operation/create_account_enhancement" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_account_enhancement" id="operation/create_account_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/create_account_enhancement" aria-label="tag/Account-Enhancements/operation/create_account_enhancement"></a>Create Account Enhancement<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates a new account enhancement.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a new account enhancement.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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=sample-enhancement-id</span></div><div><div html="<p>The identifier of the item you are targeting.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You must use an <a href="https://go.cpanel.net/add-account-enhancements">account enhancements ID</a> that a 3rd-party plugin defines.</li>
<li>To return a list of valid account enhancement IDs, run the WHM API 1 <code>list_account_enhancements</code> function.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The identifier of the item you are targeting.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You must use an <a href="https://go.cpanel.net/add-account-enhancements">account enhancements ID</a> that a 3rd-party plugin defines.</li>
<li>To return a list of valid account enhancement IDs, run the WHM API 1 <code>list_account_enhancements</code> function.</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"> <!-- --><= 80 characters<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=featurename 5000</span></div><div><div html="<p>The name of the account enhancement.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the account enhancement.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/create_account_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/create_account_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:R99a51a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99a51a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99a51a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99a51a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99a51a:0" aria-labelledby="tab:R99a51a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
create_account_enhancement <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'featurename 5000'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'sample-enhancement-id'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99a51a:1" aria-labelledby="tab:R99a51a: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:R9pa51a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pa51a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pa51a:0" aria-labelledby="tab:R9pa51a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"featurename 5000"</span></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">"command"</span>: <span class="token string">"create_account_enhancement"</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/Account-Enhancements/operation/delete_account_enhancement" data-section-id="tag/Account-Enhancements/operation/delete_account_enhancement" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_account_enhancement" id="operation/delete_account_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/delete_account_enhancement" aria-label="tag/Account-Enhancements/operation/delete_account_enhancement"></a>Remove an Account Enhancement<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes an account enhancement.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes an account enhancement.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=enhancement 5000</span></div><div><div html="<p>The name of the account enhancement.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the account enhancement.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/delete_account_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/delete_account_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:R99e51a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99e51a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99e51a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99e51a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99e51a:0" aria-labelledby="tab:R99e51a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
delete_account_enhancement <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'enhancement 5000'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99e51a:1" aria-labelledby="tab:R99e51a: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:R9pe51a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pe51a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pe51a:0" aria-labelledby="tab:R9pe51a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"delete_account_enhancement"</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/Account-Enhancements/operation/modify_account_enhancement" data-section-id="tag/Account-Enhancements/operation/modify_account_enhancement" class="sc-dntaoT ceciOs"><div data-section-id="operation/modify_account_enhancement" id="operation/modify_account_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/modify_account_enhancement" aria-label="tag/Account-Enhancements/operation/modify_account_enhancement"></a>Update Account Enhancement<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function modifies an account enhancement.</p>
<p><strong>Important:</strong></p>
<ul>
<li>When you call this function, you <strong>must</strong> include at least one of
the <code>id</code> or <code>name</code> parameters. Lack of a second parameter will result
in no change.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies an account enhancement.</p>
<p><strong>Important:</strong></p>
<ul>
<li>When you call this function, you <strong>must</strong> include at least one of
the <code>id</code> or <code>name</code> parameters. Lack of a second parameter will result
in no change.</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="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=sample-enhancement-id</span></div><div><div html="<p>The account enhancement&#39;s new identifier.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You must use an <a href="https://go.cpanel.net/account-enhancements">account enhancements</a> ID that a 3rd-party plugin defines.</li>
<li>To return a list of valid account enhancement IDs, run the WHM API 1 <code>list_account_enhancements</code> function.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account enhancement's new identifier.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You must use an <a href="https://go.cpanel.net/account-enhancements">account enhancements</a> ID that a 3rd-party plugin defines.</li>
<li>To return a list of valid account enhancement IDs, run the WHM API 1 <code>list_account_enhancements</code> function.</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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=enhancement 5000</span></div><div><div html="<p>The name of the account enhancement.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the account enhancement.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modify_account_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modify_account_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:R99i51a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99i51a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99i51a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99i51a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99i51a:0" aria-labelledby="tab:R99i51a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modify_account_enhancement <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'enhancement 5000'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'sample-enhancement-id'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99i51a:1" aria-labelledby="tab:R99i51a: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:R9pi51a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pi51a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pi51a:0" aria-labelledby="tab:R9pi51a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="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">"modify_account_enhancement"</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/Account-Enhancements/operation/unassign_account_enhancement" data-section-id="tag/Account-Enhancements/operation/unassign_account_enhancement" class="sc-dntaoT ceciOs"><div data-section-id="operation/unassign_account_enhancement" id="operation/unassign_account_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/unassign_account_enhancement" aria-label="tag/Account-Enhancements/operation/unassign_account_enhancement"></a>Unassign Account Enhancement<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes an Account Enhancement from a cPanel account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes an Account Enhancement 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=""><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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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 username of the account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the account.</p>
</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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=enhancement 5000</span></div><div><div html="<p>The name of the account enhancement.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the account enhancement.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/unassign_account_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/unassign_account_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:R99m51a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99m51a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99m51a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99m51a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99m51a:0" aria-labelledby="tab:R99m51a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
unassign_account_enhancement <span class="token punctuation">\</span>
<span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'enhancement 5000'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99m51a:1" aria-labelledby="tab:R99m51a: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:R9pm51a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pm51a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pm51a:0" aria-labelledby="tab:R9pm51a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"unassign_account_enhancement"</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/Account-Enhancements/operation/assign_account_enhancement" data-section-id="tag/Account-Enhancements/operation/assign_account_enhancement" class="sc-dntaoT ceciOs"><div data-section-id="operation/assign_account_enhancement" id="operation/assign_account_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/assign_account_enhancement" aria-label="tag/Account-Enhancements/operation/assign_account_enhancement"></a>Assign Account Enhancement<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function assigns an Account Enhancement to a cPanel account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function assigns an Account Enhancement to 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="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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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 username of the account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the account.</p>
</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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=enhancement 5000</span></div><div><div html="<p>The name of the account enhancement.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the account enhancement.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/assign_account_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/assign_account_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:R99q51a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99q51a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99q51a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99q51a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99q51a:0" aria-labelledby="tab:R99q51a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
assign_account_enhancement <span class="token punctuation">\</span>
<span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'enhancement 5000'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99q51a:1" aria-labelledby="tab:R99q51a: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:R9pq51a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pq51a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pq51a:0" aria-labelledby="tab:R9pq51a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"assign_account_enhancement"</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/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>Accounts / Account Management</p>
"><p>Accounts / Account Management</p>
</div></div></div><div id="tag/Account-Management/operation/untrack_acct_id" data-section-id="tag/Account-Management/operation/untrack_acct_id" class="sc-dntaoT ceciOs"><div data-section-id="operation/untrack_acct_id" id="operation/untrack_acct_id" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management/operation/untrack_acct_id" aria-label="tag/Account-Management/operation/untrack_acct_id"></a>Remove UID or GID from tracked list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes a user identification number (UID) or group
identification number (GID) from the tracked ID list.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a user identification number (UID) or group
identification number (GID) from the tracked ID list.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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_exists" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">check_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">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">check_exists=1</span></div><div><div html="<p>Whether to prevent removal of user or group IDs currently in use.</p>
<ul>
<li><code>1</code> — Prevent removal.</li>
<li><code>0</code> — Do <strong>not</strong> prevent removal.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to prevent removal of user or group IDs currently in use.</p>
<ul>
<li><code>1</code> — Prevent removal.</li>
<li><code>0</code> — Do <strong>not</strong> prevent removal.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="check_quota" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">check_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">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">check_quota=1</span></div><div><div html="<p>Whether to prevent removal of the user ID if the quota system tracks associated files.</p>
<ul>
<li><code>1</code> — Prevent removal.</li>
<li><code>0</code> — Do <strong>not</strong> prevent removal.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>This parameter <strong>only</strong> applies to user IDs and <strong>not</strong> group IDs.</li>
<li>You cannot check filesystems if the quota system does <strong>not</strong> track them.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to prevent removal of the user ID if the quota system tracks associated files.</p>
<ul>
<li><code>1</code> — Prevent removal.</li>
<li><code>0</code> — Do <strong>not</strong> prevent removal.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>This parameter <strong>only</strong> applies to user IDs and <strong>not</strong> group IDs.</li>
<li>You cannot check filesystems if the quota system does <strong>not</strong> track them.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="protect_system" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">protect_system</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">protect_system=1</span></div><div><div html="<p>Whether to prevent removal of system user or group IDs.</p>
<ul>
<li><code>1</code> — Prevent removal.</li>
<li><code>0</code> — Do <strong>not</strong> prevent removal.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to prevent removal of system user or group IDs.</p>
<ul>
<li><code>1</code> — Prevent removal.</li>
<li><code>0</code> — Do <strong>not</strong> prevent removal.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="uid or gid" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">uid or gid</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">uid or gid=1012</span></div><div><div html="<p>The user or group ID to remove from the track list.</p>
<p><strong>Note:</strong></p>
<p> You <strong>must</strong> include the <code>uid</code> parameter, the <code>gid</code> parameter, or both.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user or group ID to remove from the track list.</p>
<p><strong>Note:</strong></p>
<p> You <strong>must</strong> include the <code>uid</code> parameter, the <code>gid</code> parameter, or both.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/untrack_acct_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/untrack_acct_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:R154671a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154671a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154671a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154671a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154671a:0" aria-labelledby="tab:R154671a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
untrack_acct_id <span class="token punctuation">\</span>
uid or <span class="token assign-left variable">gid</span><span class="token operator">=</span><span class="token string">'1012'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154671a:1" aria-labelledby="tab:R154671a: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:R174671a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174671a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174671a:0" aria-labelledby="tab:R174671a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"untrack_acct_id"</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/Account-Management/operation/personalization_get" data-section-id="tag/Account-Management/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/Account-Management/operation/personalization_get" aria-label="tag/Account-Management/operation/personalization_get"></a>Return data from NVData 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.</p>
<p><strong>Note:</strong></p>
<p>You can <strong>only</strong> call this function as a JSON request. For more information about
additional output options, run the <code>whmapi1 --help</code> command.</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.</p>
<p><strong>Note:</strong></p>
<p>You can <strong>only</strong> call this function as a JSON request. For more information about
additional output options, run the <code>whmapi1 --help</code> command.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></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=""><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 or null</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> <!-- --><= 2048 characters<!-- --> </span></span></div> <div><div html="<p>A list of NVData keys stored on the server.</p>
<p><strong>Note:</strong></p>
<p>If you did <strong>not</strong> set a value for the requested keys, the system returns
a null value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of NVData keys stored on the server.</p>
<p><strong>Note:</strong></p>
<p>If you did <strong>not</strong> set a value for the requested keys, the system returns
a null value.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="store" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">store</span></td><td class="sc-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"> <!-- --><= 128 characters<!-- --> </span></span></div> <div><div html="<p>The name under which the values are stored.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name under which the values are stored.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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="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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</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:R154a71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154a71a:0" tabindex="0" data-rttab="true">Payload</li><li class="react-tabs__tab" role="tab" id="tab:R154a71a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154a71a:1" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154a71a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R154a71a: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:R154a71a:0" aria-labelledby="tab:R154a71a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"milk"</span>,</div></li><li><div class="hoverable "><span class="token string">"coffee"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"store"</span>: <span class="token string">"beverages"</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:R154a71a:1" aria-labelledby="tab:R154a71a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154a71a:2" aria-labelledby="tab:R154a71a: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:R174a71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174a71a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174a71a:0" aria-labelledby="tab:R174a71a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="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></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">"command"</span>: <span class="token string">"personalization_get"</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/Account-Management/operation/personalization_set" data-section-id="tag/Account-Management/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/Account-Management/operation/personalization_set" aria-label="tag/Account-Management/operation/personalization_set"></a>Save data to NVData file<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function is used to save personalization data for a WHM user to a
datastore on disk.</p>
<p>We call this system cPanel NVData. </p>
<p>cPanel NVData is a per-login configuration storage mechanism that you can use to
maintain persistent user interface settings across multiple sessions.</p>
<p>This includes custom settings for your own themes and plugins.</p>
<p>This function is used to save personalzation data for WHM users <strong>only</strong>. If you want to save personalization data for cPanel users, use the
UAPI function <code>personalization_set</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function is used to save personalization data for a WHM user to a
datastore on disk.</p>
<p>We call this system cPanel NVData. </p>
<p>cPanel NVData is a per-login configuration storage mechanism that you can use to
maintain persistent user interface settings across multiple sessions.</p>
<p>This includes custom settings for your own themes and plugins.</p>
<p>This function is used to save personalzation data for WHM users <strong>only</strong>. If you want to save personalization data for cPanel users, use the
UAPI function <code>personalization_set</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><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=""><td kind="field" title="api.version" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">api.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">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><div html="<p>The WHM API version number</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WHM API version number</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="personalization" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">personalization</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><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>An object you want to store.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An object you want to store.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="store" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">store</span></td><td class="sc-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"> <!-- --><= 128 characters<!-- --> </span></span></div> <div><div html="<p>The name under which the values will be stored.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name under which the values will be stored.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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="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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</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:R154e71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154e71a:0" tabindex="0" data-rttab="true">Payload</li><li class="react-tabs__tab" role="tab" id="tab:R154e71a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154e71a:1" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154e71a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R154e71a: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:R154e71a:0" aria-labelledby="tab:R154e71a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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.version"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"store"</span>: <span class="token string">"beverages"</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:R154e71a:1" aria-labelledby="tab:R154e71a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154e71a:2" aria-labelledby="tab:R154e71a: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:R174e71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174e71a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174e71a:0" aria-labelledby="tab:R174e71a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="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></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">"command"</span>: <span class="token string">"personalization_set"</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/Account-Management/operation/removeacct" data-section-id="tag/Account-Management/operation/removeacct" class="sc-dntaoT ceciOs"><div data-section-id="operation/removeacct" id="operation/removeacct" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management/operation/removeacct" aria-label="tag/Account-Management/operation/removeacct"></a>Delete cPanel account<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deletes a cPanel or WHM account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a cPanel or WHM 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="keepdns" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">keepdns</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">keepdns=0</span></div><div><div html="<p>Whether to retain the account&#39;s DNS entries.</p>
<ul>
<li><code>1</code> — Retain DNS entries.</li>
<li><code>0</code> — Delete DNS entries.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to retain the account's DNS entries.</p>
<ul>
<li><code>1</code> — Retain DNS entries.</li>
<li><code>0</code> — Delete DNS entries.</li>
</ul>
</div></div></div></td></tr><tr class=""><td class="sc-ovuCP sc-eauhAA dEkioI iQpMVv deprecated" kind="field" title="user"><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></div><div><span type="warning" class="sc-jtQUzJ jmDXKf"> <!-- -->Deprecated<!-- --> </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 account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's username.</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 account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 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="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">/removeacct</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/removeacct</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154i71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154i71a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154i71a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154i71a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154i71a:0" aria-labelledby="tab:R154i71a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
removeacct <span class="token punctuation">\</span>
<span class="token assign-left variable">username</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:R154i71a:1" aria-labelledby="tab:R154i71a: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:R174i71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174i71a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174i71a:0" aria-labelledby="tab:R174i71a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"removeacct"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"raw"</span>: <span class="token string">"\"raw\":\"Running pre removal script (/usr/local/cpanel/scripts/prekillacct)......Done\\nCollecting Domain Name and IP...User: example\\nDomain: example.com\\n...Done\\nLocking account and setting shell to nologin...Locking password for user example.\\npasswd: Success\\n...Done\\nKilling all processes owned by user......Done\\nRemoving Sessions.........Done\\nRemoving Suspended Info.........Done\\nCleaning Virtfs.........Done\\nRemoving Web Logs......Done\\nRemoving Bandwidth Files......Done\\nRemoving Email Sending Limits Cache......Done\\nRemoving DKIM keys......Done\\nRemoving Crontab......Done\\nRemoving HTTP Virtual Hosts...Removed the following non-SSL virtual hosts: example.com\\nRemoved the following SSL virtual hosts:\\n...Done\\nRemoving ftp Virtual Hosts......Done\\nRemoving user's web content directory symlinks......Done\\nRemoving MySQL databases and users......Done\\nRemoving PostgreSQL databases and users......Done\\nRemoving User & Group.......Success...Done\\nRemoving DNS Entries...example.com => deleted from hostname. \\n...Done\\nRemoving Email Setup...Removing /etc/valiases/example.com\\n...Done\\nRemoving mailman lists......Done\\nUpdating Databases......Done\\nRemoving bandwidth limits......Done\\nRemoving Counter Data......Done\\nAdding IP back to the IP address pool...System has 2 free ips.\\n...Done\\nRemoving user's cPanel Databases & Updating......Done\\nReloading Services......Done\\nRemoving mail and service configs...\\n...Done\\nSending Contacts......Done\\nUpdating internal databases...Updating ftp passwords for example\\nPurging ftp user example\\nFtp password files updated.\\nFtp vhost passwords synced\\n...Done\\nRunning post removal scripts (/usr/local/cpanel/scripts/legacypostkillacct, /usr/local/cpanel/scripts/postkillacct)......Done\\nAccount Removal Complete!!!...example account removed...Done\\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">"reason"</span>: <span class="token string">"example account removed"</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/Account-Management/operation/get_homedir_roots" data-section-id="tag/Account-Management/operation/get_homedir_roots" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_homedir_roots" id="operation/get_homedir_roots" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management/operation/get_homedir_roots" aria-label="tag/Account-Management/operation/get_homedir_roots"></a>Return home directories list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns all the directories where the system stores
users&#39; home directories. It returns them in descending order, based on the
current amount of available free disk space for each directory. For example,
the first directory the function lists has the most available free disk space.</p>
<p><strong>Note:</strong></p>
<p>Use WHM&#39;s Basic WebHost Manager Setup (WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Basic WebHost Manager Setup) to configure where the system will create a new user&#39;s home directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns all the directories where the system stores
users' home directories. It returns them in descending order, based on the
current amount of available free disk space for each directory. For example,
the first directory the function lists has the most available free disk space.</p>
<p><strong>Note:</strong></p>
<p>Use WHM's Basic WebHost Manager Setup (WHM >> Home >> Server Configuration >> Basic WebHost Manager Setup) to configure where the system will create a new 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_homedir_roots</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_homedir_roots</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154m71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154m71a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154m71a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154m71a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154m71a:0" aria-labelledby="tab:R154m71a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_homedir_roots
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154m71a:1" aria-labelledby="tab:R154m71a: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:R174m71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174m71a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174m71a:0" aria-labelledby="tab:R174m71a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_homedir_roots"</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/Account-Management/operation/has_digest_auth" data-section-id="tag/Account-Management/operation/has_digest_auth" class="sc-dntaoT ceciOs"><div data-section-id="operation/has_digest_auth" id="operation/has_digest_auth" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management/operation/has_digest_auth" aria-label="tag/Account-Management/operation/has_digest_auth"></a>Validate cPanel account Digest Authentication<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks whether Digest Authentication is enabled for
a cPanel user. Windows® Vista, Windows® 7, and Windows® 8 require Digest Authentication
support in order to access <a href="https://docs.cpanel.net/cpanel/files/web-disk/">Web Disk</a> over an unencrypted connection.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether Digest Authentication is enabled for
a cPanel user. Windows® Vista, Windows® 7, and Windows® 8 require Digest Authentication
support in order to access <a href="https://docs.cpanel.net/cpanel/files/web-disk/">Web Disk</a> over an unencrypted connection.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=username</span></div><div><div html="<p>The cPanel account username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/has_digest_auth</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/has_digest_auth</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154q71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154q71a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154q71a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154q71a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154q71a:0" aria-labelledby="tab:R154q71a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
has_digest_auth <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R154q71a:1" aria-labelledby="tab:R154q71a: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:R174q71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174q71a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174q71a:0" aria-labelledby="tab:R174q71a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"digestauth"</span>: <span class="token number">1</span></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">"command"</span>: <span class="token string">"has_digest_auth"</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/Account-Management/operation/set_digest_auth" data-section-id="tag/Account-Management/operation/set_digest_auth" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_digest_auth" id="operation/set_digest_auth" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management/operation/set_digest_auth" aria-label="tag/Account-Management/operation/set_digest_auth"></a>Enable or disable Digest Authentication<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables or disables Digest Authentication for an account. Windows Vista®,
Windows® 7, and Windows® 8 requires that you enable Digest Authentication support in order
to access your <a href="https://docs.cpanel.net/cpanel/files/web-disk/">Web Disk</a> over a clear text,
unencrypted connection.</p>
<p><strong>Note:</strong></p>
<p>If the server has an SSL certificate that a recognized certificate authority signed and you
can make an SSL connection over port <code>2078</code>, you do <strong>not</strong> need to enable Digest Authentication.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables or disables Digest Authentication for an account. Windows Vista®,
Windows® 7, and Windows® 8 requires that you enable Digest Authentication support in order
to access your <a href="https://docs.cpanel.net/cpanel/files/web-disk/">Web Disk</a> over a clear text,
unencrypted connection.</p>
<p><strong>Note:</strong></p>
<p>If the server has an SSL certificate that a recognized certificate authority signed and you
can make an SSL connection over port <code>2078</code>, you do <strong>not</strong> need to enable Digest 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=""><td kind="field" title="enabledigest or digestauth" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enabledigest or digestauth</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">enabledigest or digestauth=1</span></div><div><div html="<p>Whether to enable Digest Authentication 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 Digest Authentication 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="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 account&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 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></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 account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 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="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">/set_digest_auth</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_digest_auth</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154u71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154u71a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154u71a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154u71a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154u71a:0" aria-labelledby="tab:R154u71a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_digest_auth <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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">'123456luggage'</span> <span class="token punctuation">\</span>
enabledigest or <span class="token assign-left variable">digestauth</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:R154u71a:1" aria-labelledby="tab:R154u71a: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:R174u71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174u71a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174u71a:0" aria-labelledby="tab:R174u71a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_digest_auth"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Digest Authentication enabled."</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/Account-Management/operation/has_mycnf_for_cpuser" data-section-id="tag/Account-Management/operation/has_mycnf_for_cpuser" class="sc-dntaoT ceciOs"><div data-section-id="operation/has_mycnf_for_cpuser" id="operation/has_mycnf_for_cpuser" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management/operation/has_mycnf_for_cpuser" aria-label="tag/Account-Management/operation/has_mycnf_for_cpuser"></a>Validate MySQL Configuration file<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks whether a cPanel user&#39;s home directory contains
a valid .my.cnf file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether a cPanel user's home directory contains
a valid .my.cnf 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="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=user</span></div><div><div html="<p>The cPanel account username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/has_mycnf_for_cpuser</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/has_mycnf_for_cpuser</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155271a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155271a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155271a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155271a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155271a:0" aria-labelledby="tab:R155271a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
has_mycnf_for_cpuser <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:R155271a:1" aria-labelledby="tab:R155271a: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:R175271a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175271a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175271a:0" aria-labelledby="tab:R175271a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_mycnf_for_cpuser"</span>: <span class="token number">1</span></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">"command"</span>: <span class="token string">"has_mycnf_for_cpuser"</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/Account-Management/operation/listaccts" data-section-id="tag/Account-Management/operation/listaccts" class="sc-dntaoT ceciOs"><div data-section-id="operation/listaccts" id="operation/listaccts" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management/operation/listaccts" aria-label="tag/Account-Management/operation/listaccts"></a>Return cPanel accounts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the accounts on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the accounts on the 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="search" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">search</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">search=username</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>
<p><strong>Note:</strong></p>
<ul>
<li>The system matches the PCRE against the <code>searchtype</code> parameter&#39;s specified type.</li>
<li>If you do not specify a value for both the <code>searchtype</code> and <code>search</code> parameters,
the function returns all of the server&#39;s accounts.</li>
</ul>
" 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>
<p><strong>Note:</strong></p>
<ul>
<li>The system matches the PCRE against the <code>searchtype</code> parameter's specified type.</li>
<li>If you do not specify a value for both the <code>searchtype</code> and <code>search</code> parameters,
the function returns all of the server's accounts.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="searchmethod" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">searchmethod</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"exact"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"regex"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">searchmethod=exact</span></div><div><div html="<p>The function&#39;s search method.</p>
<ul>
<li><code>exact</code> - The matched value and the <code>search</code> value <strong>must</strong> be identical.</li>
<li><code>regex</code> - The matched value must contain the <code>search</code> value.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The function's search method.</p>
<ul>
<li><code>exact</code> - The matched value and the <code>search</code> value <strong>must</strong> be identical.</li>
<li><code>regex</code> - The matched value must contain the <code>search</code> value.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="searchtype" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">searchtype</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"domain"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"owner"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"user"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ip"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"package"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">searchtype=domain</span></div><div><div html="<p>The account information to query. If you do not specify a value
for both the <code>searchtype</code> and <code>search</code> parameters, the function returns all
of the server&#39;s accounts.</p>
<ul>
<li><code>domain</code> - Match domains against the <code>search</code> regular expression.</li>
<li><code>owner</code> - Match the WHM user who owns the account against the <code>search</code> regular expression.</li>
<li><code>user</code> - Match usernames against the <code>search</code> regular expression.</li>
<li><code>ip</code> - Match IP addresses against the <code>search</code> regular expression.</li>
<li><code>package</code> - Match hosting plans (packages) against the <code>search</code> regular expression.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account information to query. If you do not specify a value
for both the <code>searchtype</code> and <code>search</code> parameters, the function returns all
of the server's accounts.</p>
<ul>
<li><code>domain</code> - Match domains against the <code>search</code> regular expression.</li>
<li><code>owner</code> - Match the WHM user who owns the account against the <code>search</code> regular expression.</li>
<li><code>user</code> - Match usernames against the <code>search</code> regular expression.</li>
<li><code>ip</code> - Match IP addresses against the <code>search</code> regular expression.</li>
<li><code>package</code> - Match hosting plans (packages) against the <code>search</code> regular expression.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="want" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">want</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">want=domain,diskused</span></div><div><div html="<p>The returns to include in the output for each account.</p>
<p>If you do not specify a value, the function&#39;s output includes all of its returns.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The returns to include in the output for each account.</p>
<p>If you do not specify a value, the function's output includes all of its returns.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/listaccts</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/listaccts</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155671a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155671a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155671a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155671a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155671a:0" aria-labelledby="tab:R155671a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
listaccts
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155671a:1" aria-labelledby="tab:R155671a: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:R175671a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175671a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175671a:0" aria-labelledby="tab:R175671a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acct"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"child_nodes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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 string">"nodealias"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"workload"</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">"disklimit"</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 string">"14M"</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">"username@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_backup"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inodeslimit"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inodesused"</span>: <span class="token number">1</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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"0101:ca75:0101:ca75:0101:ca75:0101:ca77"</span></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_locked"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"legacy_backup"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox_format"</span>: <span class="token string">"mdbox"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_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">"max_email_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">"max_emailacct_quota"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxaddons"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxftp"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxlst"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxparked"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxpop"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxsql"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxsub"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"min_defer_fail_to_trigger_protection"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"outgoing_mail_hold"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"outgoing_mail_suspended"</span>: <span class="token number">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">"partition"</span>: <span class="token string">"home"</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">"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">"startdate"</span>: <span class="token string">"13 May 22 16:03"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspended"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspendreason"</span>: <span class="token string">"not suspended"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspendtime"</span>: <span class="token number">1594040856</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temporary"</span>: <span class="token number">0</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">1001</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"unix_startdate"</span>: <span class="token number">1369256589</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></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">"command"</span>: <span class="token string">"listaccts"</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/Account-Management/operation/modifyacct" data-section-id="tag/Account-Management/operation/modifyacct" class="sc-dntaoT ceciOs"><div data-section-id="operation/modifyacct" id="operation/modifyacct" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management/operation/modifyacct" aria-label="tag/Account-Management/operation/modifyacct"></a>Update cPanel account<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function modifies a cPanel account.</p>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you <strong>do not</strong> modify a single cPanel account&#39;s settings if that cPanel account uses a hosting plan (package). If the package values change, <strong>the system will overwrite any of your custom values with the package&#39;s new values</strong>.</p>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of SPF resource records on DNS.</p>
<ul>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because <a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>. CentOS 7 servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the <a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies a cPanel account.</p>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you <strong>do not</strong> modify a single cPanel account's settings if that cPanel account uses a hosting plan (package). If the package values change, <strong>the system will overwrite any of your custom values with the package's new values</strong>.</p>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of SPF resource records on DNS.</p>
<ul>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because <a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>. CentOS 7 servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the <a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</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_enhancements" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account_enhancements</span></td><td class="sc-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">account_enhancements=My Custom Enhancement&account_enhancements=Sample Enhancement</span> -<!-- --> <!-- -->Assign multiple enhancements</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account_enhancements=My Custom Enhancement</span> -<!-- --> <!-- -->Assign one enhancement</li></ul><div><div html="<p>A list of names for <a href="https://go.cpanel.net/account-enhancements">Account Enhancements</a> to assign to the cPanel account.
To view your server&#39;s Account Enhancements, run WHM API 1&#39;s <code>list_account_enhancements</code> function.</p>
<p><strong>Warning:</strong></p>
<p>You must provide a complete list of Account Enhancements for the cPanel account. The parameter will add or remove Account Enhancements
based on the names that you provide.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of names for <a href="https://go.cpanel.net/account-enhancements">Account Enhancements</a> to assign to the cPanel account.
To view your server's Account Enhancements, run WHM API 1's <code>list_account_enhancements</code> function.</p>
<p><strong>Warning:</strong></p>
<p>You must provide a complete list of Account Enhancements for the cPanel account. The parameter will add or remove Account Enhancements
based on the names that you provide.</p>
</div></div></div></td></tr><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">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">BACKUP=1</span></div><div><div html="<p>Whether backups are enabled for the cPanel account.</p>
<ul>
<li><code>1</code> — Enable backups.</li>
<li><code>0</code> — Disable backups.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> have <code>root</code>-level privileges to set this parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether backups are enabled for the cPanel account.</p>
<ul>
<li><code>1</code> — Enable backups.</li>
<li><code>0</code> — Disable backups.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> have <code>root</code>-level privileges to set this parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="BWLIMIT" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand BWLIMIT"><span class="property-name">BWLIMIT</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">BWLIMIT=unlimited</span></div><div><div html="<p>The cPanel account&#39;s maximum bandwidth use, in bytes.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The cPanel account can use unlimited bandwidth.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's maximum bandwidth use, in bytes.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The cPanel account can use unlimited bandwidth.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="contactemail" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">contactemail</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">contactemail=username@example.com</span></div><div><div html="<p>The cPanel account&#39;s contact email address.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's contact email address.</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="DBOWNER" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">DBOWNER</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">DBOWNER=example</span></div><div><div html="<p>The owner of the cPanel account&#39;s MySQL databases.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The owner of the cPanel account's MySQL databases.</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="DISK_BLOCK_LIMIT" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">DISK_BLOCK_LIMIT</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">DISK_BLOCK_LIMIT=100000000</span></div><div><div html="<p>The number of disk blocks for the cPanel account, in kilobytes (KB).</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of disk blocks for the cPanel account, in kilobytes (KB).</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="DNS" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">DNS</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">DNS=example.com</span></div><div><div html="<p>The cPanel account&#39;s main domain.</p>
<p>This parameter is an alias of <code>domain</code>. If you set both
the <code>DNS</code> and <code>domain</code> parameters, the <code>DNS</code> parameter will
override the <code>domain</code> parameter.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's main domain.</p>
<p>This parameter is an alias of <code>domain</code>. If you set both
the <code>DNS</code> and <code>domain</code> parameters, the <code>DNS</code> parameter will
override the <code>domain</code> parameter.</p>
<p>This parameter defaults to the defined system 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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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 cPanel account&#39;s main domain.</p>
<p>This parameter is an alias of <code>DNS</code>. If you set both
the <code>DNS</code> and <code>domain</code> parameters, the <code>DNS</code> parameter will
override the <code>domain</code> parameter.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's main domain.</p>
<p>This parameter is an alias of <code>DNS</code>. If you set both
the <code>DNS</code> and <code>domain</code> parameters, the <code>DNS</code> parameter will
override the <code>domain</code> parameter.</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="HASCGI" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">HASCGI</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">HASCGI=1</span></div><div><div html="<p>Whether CGI access is enabled for the cPanel account.</p>
<ul>
<li><code>1</code> — Enable CGI access.</li>
<li><code>0</code> — Disable CGI access.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>When a <a href="https://go.cpanel.net/howtouseserverprofiles">server profile</a> disables the Web Server role, you <strong>cannot</strong> enable CGI access.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether CGI access is enabled for the cPanel account.</p>
<ul>
<li><code>1</code> — Enable CGI access.</li>
<li><code>0</code> — Disable CGI access.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>When a <a href="https://go.cpanel.net/howtouseserverprofiles">server profile</a> disables the Web Server role, you <strong>cannot</strong> enable CGI access.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="HASDKIM" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">HASDKIM</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">HASDKIM=1</span></div><div><div html="<p>Whether DKIM is enabled for the cPanel account.</p>
<ul>
<li><code>1</code> — Enable DKIM.</li>
<li><code>0</code> — Disable DKIM.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether DKIM is enabled for the cPanel account.</p>
<ul>
<li><code>1</code> — Enable DKIM.</li>
<li><code>0</code> — Disable DKIM.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="HASDMARC" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">HASDMARC</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">HASDMARC=1</span></div><div><div html="<p>Whether DMARC is enabled for the cPanel account.</p>
<ul>
<li><code>1</code> — Enable DMARC.</li>
<li><code>0</code> — Disable DMARC.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether DMARC is enabled for the cPanel account.</p>
<ul>
<li><code>1</code> — Enable DMARC.</li>
<li><code>0</code> — Disable DMARC.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="HASSHELL" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">HASSHELL</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">HASSHELL=1</span></div><div><div html="<p>Whether shell (SSH) access is enabled for the cPanel account.</p>
<ul>
<li><code>1</code> — Enable shell access.</li>
<li><code>0</code> — Disable shell access.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>We <strong>strongly</strong> recommend that you use the <code>shell</code> parameter to specify a shell for SSH access.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether shell (SSH) access is enabled for the cPanel account.</p>
<ul>
<li><code>1</code> — Enable shell access.</li>
<li><code>0</code> — Disable shell access.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>We <strong>strongly</strong> recommend that you use the <code>shell</code> parameter to specify a shell for SSH access.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="HASSPF" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">HASSPF</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">HASSPF=1</span></div><div><div html="<p>Whether SPF is enabled for the cPanel account.</p>
<ul>
<li><code>1</code> — Enable SPF.</li>
<li><code>0</code> — Disable SPF.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether SPF is enabled for the cPanel account.</p>
<ul>
<li><code>1</code> — Enable SPF.</li>
<li><code>0</code> — Disable SPF.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="LANG" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">LANG</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">LANG=english-utf8</span></div><div><div html="<p>The cPanel account&#39;s display language.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's display language.</p>
<p>This parameter defaults to the defined system value.</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><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">LOCALE=en</span></div><div><div html="<p>The cPanel account&#39;s default locale, in two-letter <a href="https://www.iso.org/iso-3166-country-codes.html">ISO-3166 code</a> format.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's default locale, in two-letter <a href="https://www.iso.org/iso-3166-country-codes.html">ISO-3166 code</a> format.</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="mail_node_alias" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand mail_node_alias"><span class="property-name">mail_node_alias</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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">mail_node_alias=mailnode</span></div><div><div html="<p>The server that will manage the cPanel account&#39;s mail.</p>
<ul>
<li><p><code>.local</code> — Make the local server manage the cPanel account’s mail. If the account currently uses a <a href="https://go.cpanel.net/cPanelGlossary#child-node">child node</a> for its mail, this will transfer the account’s mail to the local server.</p>
</li>
<li><p>The alias (friendly name) of a child node that should manage the cPanel account’s mail.</p>
<p>When you distribute an account’s mail, the function adds a <code>LINK</code> entry to the
<a href="https://go.cpanel.net/ThecPanelLogFiles"><code>/var/cpanel/accounting.log</code></a> file.</p>
</li>
</ul>
<p>This parameter defaults to the account’s current mail node, or <code>.local</code> if the account’s mail is on the local server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server that will manage the cPanel account's mail.</p>
<ul>
<li><p><code>.local</code> — Make the local server manage the cPanel account’s mail. If the account currently uses a <a href="https://go.cpanel.net/cPanelGlossary#child-node">child node</a> for its mail, this will transfer the account’s mail to the local server.</p>
</li>
<li><p>The alias (friendly name) of a child node that should manage the cPanel account’s mail.</p>
<p>When you distribute an account’s mail, the function adds a <code>LINK</code> entry to the
<a href="https://go.cpanel.net/ThecPanelLogFiles"><code>/var/cpanel/accounting.log</code></a> file.</p>
</li>
</ul>
<p>This parameter defaults to the account’s current mail node, or <code>.local</code> if the account’s mail is on the local server.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAILBOX_FORMAT" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">MAILBOX_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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"maildir"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mbox"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAILBOX_FORMAT=maildir</span></div><div><div html="<p>The storage format that the cPanel account&#39;s mailboxes use.</p>
<ul>
<li><code>maildir</code></li>
<li><code>mbox</code></li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The storage format that the cPanel account's mailboxes use.</p>
<ul>
<li><code>maildir</code></li>
<li><code>mbox</code></li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAX_DEFER_FAIL_PERCENTAGE" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAX_DEFER_FAIL_PERCENTAGE"><span class="property-name">MAX_DEFER_FAIL_PERCENTAGE</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->IntPosOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAX_DEFER_FAIL_PERCENTAGE=unlimited</span></div><div><div html="<p>The percentage of failed or deferred email messages that the
cPanel account can send per hour before outgoing mail is rate-limited.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The cPanel account can send an unlimited number of failed or deferred messages.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The percentage of failed or deferred email messages that the
cPanel account can send per hour before outgoing mail is rate-limited.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The cPanel account can send an unlimited number of failed or deferred messages.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAX_EMAIL_PER_HOUR" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAX_EMAIL_PER_HOUR"><span class="property-name">MAX_EMAIL_PER_HOUR</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->IntPosOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAX_EMAIL_PER_HOUR=unlimited</span></div><div><div html="<p>The maximum number of emails that the cPanel account can send in one hour.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The cPanel account can send an unlimited number of emails.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of emails that the cPanel account can send in one hour.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The cPanel account can send an unlimited number of emails.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAX_EMAILACCT_QUOTA" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAX_EMAILACCT_QUOTA"><span class="property-name">MAX_EMAILACCT_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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAX_EMAILACCT_QUOTA=unlimited</span></div><div><div html="<p>The maximum quota, in megabytes (MB), that the cPanel account can define
when it creates an email account.</p>
<ul>
<li><code>unlimited</code> — The cPanel account can set unlimited quotas.</li>
</ul>
<p>This parameter defaults to the defined system value, or to <code>unlimited</code> if you do not define either the <code>plan</code> or <code>MAX_EMAILACCT_QUOTA</code> parameters.</p>
<p><strong>Important:</strong></p>
<ul>
<li>This value applies to each email account, <strong>not</strong> each cPanel account.</li>
<li>If you specify a <code>MAX_EMAILACCT_QUOTA</code> value, the function will overwrite the plan&#39;s defined value for that cPanel
account.</li>
<li>We recommend that you allow the cPanel account&#39;s plan to determine this value.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum quota, in megabytes (MB), that the cPanel account can define
when it creates an email account.</p>
<ul>
<li><code>unlimited</code> — The cPanel account can set unlimited quotas.</li>
</ul>
<p>This parameter defaults to the defined system value, or to <code>unlimited</code> if you do not define either the <code>plan</code> or <code>MAX_EMAILACCT_QUOTA</code> parameters.</p>
<p><strong>Important:</strong></p>
<ul>
<li>This value applies to each email account, <strong>not</strong> each cPanel account.</li>
<li>If you specify a <code>MAX_EMAILACCT_QUOTA</code> value, the function will overwrite the plan's defined value for that cPanel
account.</li>
<li>We recommend that you allow the cPanel account's plan to determine this value.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_team_users" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">max_team_users</span></td><td class="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 .. 7 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">max_team_users=7</span></div><div><div html="<p>The maximum number of Team users for this account.
This parameter should be a number between 0 and the server&#39;s default value, inclusively.
This parameter can not be a number greater than the server&#39;s default value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of Team users for this account.
This parameter should be a number between 0 and the server's default value, inclusively.
This parameter can not be a number greater than the server's default value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXADDON" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXADDON"><span class="property-name">MAXADDON</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int999999OrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXADDON=unlimited</span></div><div><div html="<p>The cPanel account&#39;s maximum number of addon domains.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The cPanel account can use unlimited addon domains.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's maximum number of addon domains.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The cPanel account can use unlimited addon domains.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXFTP" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXFTP"><span class="property-name">MAXFTP</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int999999OrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXFTP=unlimited</span></div><div><div html="<p>The cPanel account&#39;s maximum number of FTP accounts.</p>
<ul>
<li><code>unlimited</code> — The cPanel account can create unlimited FTP accounts.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's maximum number of FTP accounts.</p>
<ul>
<li><code>unlimited</code> — The cPanel account can create unlimited FTP accounts.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXLST" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXLST"><span class="property-name">MAXLST</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int999999OrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXLST=unlimited</span></div><div><div html="<p>The cPanel account&#39;s maximum number of mailing lists.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The cPanel account can create unlimited mailing lists.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's maximum number of mailing lists.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The cPanel account can create unlimited mailing lists.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXPARK" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXPARK"><span class="property-name">MAXPARK</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int999999OrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXPARK=unlimited</span></div><div><div html="<p>The cPanel account&#39;s maximum number of parked domains (aliases).</p>
<ul>
<li><code>unlimited</code> — The cPanel account can use unlimited parked domains.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's maximum number of parked domains (aliases).</p>
<ul>
<li><code>unlimited</code> — The cPanel account can use unlimited parked domains.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXPASSENGERAPPS" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXPASSENGERAPPS"><span class="property-name">MAXPASSENGERAPPS</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int999999OrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXPASSENGERAPPS=unlimited</span></div><div><div html="<p>The cPanel account&#39;s maximum number of Ruby applications.</p>
<ul>
<li><code>unlimited</code> — The cPanel account can use unlimited Ruby applications.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's maximum number of Ruby applications.</p>
<ul>
<li><code>unlimited</code> — The cPanel account can use unlimited Ruby applications.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXPOP" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXPOP"><span class="property-name">MAXPOP</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int999999OrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXPOP=unlimited</span></div><div><div html="<p>The maximum number of email accounts for the cPanel account.</p>
<ul>
<li><code>unlimited</code> — The cPanel account can create unlimited email accounts.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of email accounts for the cPanel account.</p>
<ul>
<li><code>unlimited</code> — The cPanel account can create unlimited email accounts.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXSQL" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXSQL"><span class="property-name">MAXSQL</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int999999OrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXSQL=unlimited</span></div><div><div html="<p>The maximum number of each available type of SQL database for
the cPanel account. For example, if you set this value to <code>5</code>
and the system administrator allows MySQL® and PostgreSQL®
databases, users can create up to five MySQL databases and up
to five PostgreSQL databases.</p>
<ul>
<li><code>unlimited</code> — The cPanel account can create unlimited databases.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of each available type of SQL database for
the cPanel account. For example, if you set this value to <code>5</code>
and the system administrator allows MySQL® and PostgreSQL®
databases, users can create up to five MySQL databases and up
to five PostgreSQL databases.</p>
<ul>
<li><code>unlimited</code> — The cPanel account can create unlimited databases.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXSUB" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXSUB"><span class="property-name">MAXSUB</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int999999OrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXSUB=unlimited</span></div><div><div html="<p>The maximum number of subdomains for the cPanel account.</p>
<ul>
<li><code>unlimited</code> — The cPanel account can create unlimited subdomains.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of subdomains for the cPanel account.</p>
<ul>
<li><code>unlimited</code> — The cPanel account can create unlimited subdomains.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="modify_firewall" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">modify_firewall</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">modify_firewall=0</span></div><div><div html="<p>Whether to modify the firewall rules as part of the cPanel account modification.</p>
<ul>
<li><code>1</code> — Modify the firewall rules.</li>
<li><code>0</code> — Do <strong>not</strong> modify the firewall rules.</li>
</ul>
<p><strong>Note:</strong></p>
<p>If you do not set this parameter, the system will modify the firewall based on the <em>Do not make changes to the firewall during cPanel account modification.</em> setting in WHM&#39;s <a href="https://go.cpanel.net/whmdocsTweakSettings"><em>Tweak Settings</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to modify the firewall rules as part of the cPanel account modification.</p>
<ul>
<li><code>1</code> — Modify the firewall rules.</li>
<li><code>0</code> — Do <strong>not</strong> modify the firewall rules.</li>
</ul>
<p><strong>Note:</strong></p>
<p>If you do not set this parameter, the system will modify the firewall based on the <em>Do not make changes to the firewall during cPanel account modification.</em> setting in WHM's <a href="https://go.cpanel.net/whmdocsTweakSettings"><em>Tweak Settings</em></a> interface (<em>WHM >> Home >> Server Configuration >> Tweak Settings</em>).</p>
</div></div></div></td></tr><tr class=""><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">integer</span></div> <div><div html="<p>The priority of the cPanel account&#39;s primary mail exchanger.</p>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>The parameter name consists of <code>MXCHECK</code>, a hyphen, and the primary domain name of
the cPanel account. For example, <code>MXCHECK-example.com=10</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The priority of the cPanel account's primary mail exchanger.</p>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>The parameter name consists of <code>MXCHECK</code>, a hyphen, and the primary domain name of
the cPanel account. For example, <code>MXCHECK-example.com=10</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="newuser" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">newuser</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">newuser=example1</span></div><div><div html="<p>The cPanel account&#39;s new username.</p>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Usernames <strong>cannot</strong> begin with a number or the string <code>test</code>.</li>
<li>Usernames can contain 16 characters or fewer if database prefixes are enabled.</li>
<li>The first eight characters of usernames <strong>must</strong> be unique. MySQL requires this due to potential conflicts with cPanel account transfers. However, this limit requirement does <strong>not</strong> exist on servers that use MariaDB.</li>
<li>If you rename the cPanel account and database prefixing is enabled, you can also use the <code>rename_database_objects</code> parameter.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's new username.</p>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Usernames <strong>cannot</strong> begin with a number or the string <code>test</code>.</li>
<li>Usernames can contain 16 characters or fewer if database prefixes are enabled.</li>
<li>The first eight characters of usernames <strong>must</strong> be unique. MySQL requires this due to potential conflicts with cPanel account transfers. However, this limit requirement does <strong>not</strong> exist on servers that use MariaDB.</li>
<li>If you rename the cPanel account and database prefixing is enabled, you can also use the <code>rename_database_objects</code> parameter.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_account_authn_link" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_account_authn_link</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_account_authn_link=0</span></div><div><div html="<p>Whether to send a notification when someone links the cPanel
account to an external authentication account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when someone links the cPanel
account to an external authentication account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_account_authn_link_notification_disabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_account_authn_link_notification_disabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_account_authn_link_notification_disabled=0</span></div><div><div html="<p>Whether to send a notification when someone disables notifications
for external authentication account links.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when someone disables notifications
for external authentication account links.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_autossl_expiry" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_autossl_expiry</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_autossl_expiry=0</span></div><div><div html="<p>Whether to send a notification when an AutoSSL certificate expires.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when an AutoSSL certificate expires.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_autossl_expiry_coverage" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_autossl_expiry_coverage</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_autossl_expiry_coverage=0</span></div><div><div html="<p>Whether to send a notification AutoSSL cannot renew a certificate
because domains that fail Domain Control Validation (DCV) exist on the current
certificate.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification AutoSSL cannot renew a certificate
because domains that fail Domain Control Validation (DCV) exist on the current
certificate.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_autossl_renewal" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_autossl_renewal</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_autossl_renewal=0</span></div><div><div html="<p>Whether to send a notification when AutoSSL renews a certificate.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when AutoSSL renews a certificate.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_autossl_renewal_coverage" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_autossl_renewal_coverage</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_autossl_renewal_coverage=0</span></div><div><div html="<p>Whether to send a notification when AutoSSL renews a certificate
but the new certificate lacks at least one domain that the previous certificate
secured.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when AutoSSL renews a certificate
but the new certificate lacks at least one domain that the previous certificate
secured.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_contact_address_change" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_contact_address_change</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_contact_address_change=0</span></div><div><div html="<p>Whether to send a notification when someone changes the contact
address for the cPanel account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when someone changes the contact
address for the cPanel account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_contact_address_change_notification_disabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_contact_address_change_notification_disabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_contact_address_change_notification_disabled=0</span></div><div><div html="<p>Whether to send a notification when disables the notification
for contact address changes.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when disables the notification
for contact address changes.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_disk_limit" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_disk_limit</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_disk_limit=0</span></div><div><div html="<p>Whether to send a notification when the cPanel account reaches its disk usage limit.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when the cPanel account reaches its disk usage limit.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_password_change" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_password_change</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_password_change=0</span></div><div><div html="<p>Whether to send a notification when someone changes the cPanel account&#39;s
password.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when someone changes the cPanel account's
password.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_password_change_notification_disabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_password_change_notification_disabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_password_change_notification_disabled=0</span></div><div><div html="<p>Whether to send a notification when someone disables notifications
for password changes.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when someone disables notifications
for password changes.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_ssl_expiry" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_ssl_expiry</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_ssl_expiry=0</span></div><div><div html="<p>Whether to send a notification when an SSL certificate on the
cPanel account expires.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when an SSL certificate on the
cPanel account expires.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="OUTGOING_EMAIL_SUSPENDED" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">OUTGOING_EMAIL_SUSPENDED</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">OUTGOING_EMAIL_SUSPENDED=0</span></div><div><div html="<p>Whether to suspend outgoing email on the cPanel account.</p>
<ul>
<li><code>1</code> — Suspend outgoing email.</li>
<li><code>0</code> — Do <strong>not</strong> suspend outgoing email.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to suspend outgoing email on the cPanel account.</p>
<ul>
<li><code>1</code> — Suspend outgoing email.</li>
<li><code>0</code> — Do <strong>not</strong> suspend outgoing email.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="owner" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">owner</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">owner=reseller_name</span></div><div><div html="<p>A new owner&#39;s username or the <code>root</code> user, to change the cPanel account&#39;s owner.</p>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>The authenticated user must have <code>root</code> privileges in order to assign the cPanel account to a reseller other than that cPanel account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A new owner's username or the <code>root</code> user, to change the cPanel account's owner.</p>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>The authenticated user must have <code>root</code> privileges in order to assign the cPanel account to a reseller other than that cPanel account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="PUSHBULLET_ACCESS_TOKEN" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">PUSHBULLET_ACCESS_TOKEN</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>An access token for the cPanel account&#39;s Pushbullet™ notifications.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An access token for the cPanel account's Pushbullet™ notifications.</p>
<p>This parameter defaults to the defined system value.</p>
</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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->IntPosOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">QUOTA=unlimited</span></div><div><div html="<p>The cPanel account&#39;s disk space quota.</p>
<ul>
<li>An integer in multiples of 1,048,576 bytes.</li>
<li><code>0</code> or <code>unlimited</code> — The cPanel account&#39;s disk space is unlimited.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's disk space quota.</p>
<ul>
<li>An integer in multiples of 1,048,576 bytes.</li>
<li><code>0</code> or <code>unlimited</code> — The cPanel account's disk space is unlimited.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="remove_missing_extensions" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">remove_missing_extensions</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">remove_missing_extensions=packageext1 packageext2</span></div><div><div html="<p>A space-separated list of removed, missing, or uninstalled package extensions.</p>
<p><strong>Warning:</strong></p>
<p>This parameter removes all of the extensions that you list from the <code>_PACKAGE_EXTENSIONS</code> variable in the user file. It will <strong>not</strong> remove the extensions&#39; variables. For more information, read our <a href="https://go.cpanel.net/GuidetoPackageExtensions">Guide to Package Extensions</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A space-separated list of removed, missing, or uninstalled package extensions.</p>
<p><strong>Warning:</strong></p>
<p>This parameter removes all of the extensions that you list from the <code>_PACKAGE_EXTENSIONS</code> variable in the user file. It will <strong>not</strong> remove the extensions' variables. For more information, read our <a href="https://go.cpanel.net/GuidetoPackageExtensions">Guide to Package Extensions</a>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="rename_database_objects" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">rename_database_objects</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">rename_database_objects=0</span></div><div><div html="<p>Whether to rename the cPanel account&#39;s database objects to use a new username&#39;s database prefix.</p>
<ul>
<li><code>1</code> — Rename the cPanel account&#39;s database objects.</li>
<li><code>0</code> — Do <strong>not</strong> rename the cPanel account&#39;s database objects.</li>
</ul>
<p><strong>Warning:</strong></p>
<ul>
<li>The cPanel account owner must update any applications to use the new database object names.</li>
<li><strong>Use this parameter carefully</strong>, as it may cause confusion for system administrators.</li>
</ul>
<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>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>Note:</strong></p>
<p>This parameter <strong>only</strong> applies to servers that use database prefixing.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to rename the cPanel account's database objects to use a new username's database prefix.</p>
<ul>
<li><code>1</code> — Rename the cPanel account's database objects.</li>
<li><code>0</code> — Do <strong>not</strong> rename the cPanel account's database objects.</li>
</ul>
<p><strong>Warning:</strong></p>
<ul>
<li>The cPanel account owner must update any applications to use the new database object names.</li>
<li><strong>Use this parameter carefully</strong>, as it may cause confusion for system administrators.</li>
</ul>
<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>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>Note:</strong></p>
<p>This parameter <strong>only</strong> applies to servers that use database prefixing.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="reseller" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">reseller</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">reseller=1</span></div><div><div html="<p>Whether to grant reseller privileges to the cPanel account.</p>
<ul>
<li><code>1</code> — Grant reseller privileges.</li>
<li><code>0</code> — Do <strong>not</strong> grant reseller privileges.</li>
</ul>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> have <code>root</code>-level privileges to use this parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to grant reseller privileges to the cPanel account.</p>
<ul>
<li><code>1</code> — Grant reseller privileges.</li>
<li><code>0</code> — Do <strong>not</strong> grant reseller privileges.</li>
</ul>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> have <code>root</code>-level privileges to use this parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="RS" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">RS</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">RS=jupiter</span></div><div><div html="<p>The cPanel account&#39;s cPanel theme.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's cPanel theme.</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="shell" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">shell</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">shell=/bin/bash</span></div><div><div html="<p>The absolute filepath to the shell&#39;s location.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute filepath to the shell's location.</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="spamassassin" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">spamassassin</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">spamassassin=0</span></div><div><div html="<p>Whether Apache SpamAssassin™ is enabled for the cPanel account.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether Apache SpamAssassin™ is enabled for the cPanel account.</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="STARTDATE" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">STARTDATE</span></td><td class="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">STARTDATE=1549471343</span></div><div><div html="<p>A timestamp to use as the cPanel account&#39;s creation date.</p>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>This parameter does <strong>not</strong> provide user access controls. For example, you cannot modify a
cPanel account&#39;s date to prevent a user from logging in to the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A timestamp to use as the cPanel account's creation date.</p>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>This parameter does <strong>not</strong> provide user access controls. For example, you cannot modify a
cPanel account's date to prevent a user from logging in to the server.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="STYLE" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">STYLE</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">STYLE=Glass</span></div><div><div html="<p>The cPanel account&#39;s cPanel interface theme style.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's cPanel interface theme style.</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="update_existing_email_account_quotas" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">update_existing_email_account_quotas</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">update_existing_email_account_quotas=1</span></div><div><div html="<p>Whether to update the quota for existing email accounts to match the value of <code>MAX_EMAILACCT_QUOTA</code> setting.</p>
<ul>
<li><code>1</code> — Update quota for existing email accounts.</li>
<li><code>0</code> — Do not update quota for existing email accounts.</li>
</ul>
<p><strong>Important:</strong></p>
<p>To use this parameter, you <strong>must</strong> also use the <code>MAX_EMAILACCT_QUOTA</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to update the quota for existing email accounts to match the value of <code>MAX_EMAILACCT_QUOTA</code> setting.</p>
<ul>
<li><code>1</code> — Update quota for existing email accounts.</li>
<li><code>0</code> — Do not update quota for existing email accounts.</li>
</ul>
<p><strong>Important:</strong></p>
<p>To use this parameter, you <strong>must</strong> also use the <code>MAX_EMAILACCT_QUOTA</code> parameter.</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=example</span></div><div><div html="<p>The cPanel account&#39;s current username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account's current 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modifyacct</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modifyacct</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155a71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155a71a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155a71a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155a71a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155a71a:0" aria-labelledby="tab:R155a71a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modifyacct <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R155a71a:1" aria-labelledby="tab:R155a71a: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:R175a71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175a71a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175a71a:0" aria-labelledby="tab:R175a71a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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"</span>: <button class="collapser" aria-label="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"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"BWLIMIT"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CONTACTEMAIL"</span>: <span class="token string">"example@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CONTACTEMAIL2"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DBOWNER"</span>: <span class="token string">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DEADDOMAINS"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DEMO"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DISK_BLOCK_LIMIT"</span>: <span class="token string">"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">"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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FEATURELIST"</span>: <span class="token string">"default"</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">"HASDKIM"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASDMARC"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASSPF"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HOMEDIRLINKS"</span>: <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">"172.16.1.13"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"LEGACY_BACKUP"</span>: <span class="token string">"0"</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">"MAXADDON"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXFTP"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXLST"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPARK"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPOP"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSQL"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSUB"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_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">"MAX_EMAILACCT_QUOTA"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_EMAIL_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">"MTIME"</span>: <span class="token string">"1560518791"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MXCHECK-example.com"</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">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"PLAN"</span>: <span class="token string">"default"</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">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"RS"</span>: <span class="token string">"jupiter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"STARTDATE"</span>: <span class="token string">"1554919365"</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">"UTF8MAILBOX"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_PACKAGE_EXTENSIONS"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"__CACHE_DATA_VERSION"</span>: <span class="token string">"0.81"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modify_firewall"</span>: <span class="token string">"1"</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 string">"0"</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 string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_autossl_expiry"</span>: <span class="token string">"0"</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 string">"0"</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 string">"0"</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 string">"0"</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 string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_bandwidth_limit"</span>: <span class="token string">"0"</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 string">"0"</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 string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_disk_limit"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_password_change"</span>: <span class="token string">"0"</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 string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_ssl_expiry"</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">"setshell"</span>: <span class="token string">"/bin/bash"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"example1"</span></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">"command"</span>: <span class="token string">"modifyacct"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"Reseller data updated"</span>,</div></li><li><div class="hoverable "><span class="token string">"0 rows updated in eximstats sends database.\n0 rows updated in eximstats smtp database.\n0 rows updated in eximstats failures database.\n0 rows updated in eximstats defers database.\n"</span>,</div></li><li><div class="hoverable "><span class="token string">"Username changed from example to example1"</span>,</div></li><li><div class="hoverable "><span class="token string">"Restarting apache"</span></div></li></ul><span class="token punctuation">]</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">"Changing the cPanel account username from “example” to “example1” requires Digest Authentication to be disabled."</span>,</div></li><li><div class="hoverable "><span class="token string">"Use the Web Disk Accounts page in cPanel to re-enable Digest Authentication."</span></div></li></ul><span class="token punctuation">]</span></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">"Account Modified"</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/Account-Management/operation/changepackage" data-section-id="tag/Account-Management/operation/changepackage" class="sc-dntaoT ceciOs"><div data-section-id="operation/changepackage" id="operation/changepackage" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management/operation/changepackage" aria-label="tag/Account-Management/operation/changepackage"></a>Update user hosting plan<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function changes a cPanel account&#39;s hosting plan (package).</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes a cPanel account's hosting plan (package).</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="pkg" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">pkg</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">pkg=package1</span></div><div><div html="<p>The hosting plan&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan'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><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=username</span></div><div><div html="<p>The cPanel account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="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">/changepackage</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/changepackage</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155e71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155e71a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155e71a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155e71a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155e71a:0" aria-labelledby="tab:R155e71a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
changepackage <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">pkg</span><span class="token operator">=</span><span class="token string">'package1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155e71a:1" aria-labelledby="tab:R155e71a: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:R175e71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175e71a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175e71a:0" aria-labelledby="tab:R175e71a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"changepackage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"raw"</span>: <span class="token string">"<pre>\nChanging the account bandwidth limit from “0” to “unlimited”.\nChanging Feature List to default\nChanging the maximum email accounts from “unlimited” to “unlimited”.\nChanging the maximum SQL databases from “unlimited” to “unlimited”.\nChanging the maximum FTP accounts from “unlimited” to “unlimited”.\nChanging the maximum mailing lists from “unlimited” to “unlimited”.\nChanging the maximum subdomains from “unlimited” to “unlimited”.\nChanging the maximum email quota from “unlimited” to “unlimited” …\nChanging \"Maximum Hourly Email by Domain Relayed\" from unlimited to unlimited\nChanging \"Maximum percentage of failed or deferred messages a domain may send per hour\" from unlimited to unlimited\nChanging the maximum parked domains from “unlimited” to “0”.\nChanging the maximum addon domains from “unlimited” to “0”.\nRemoving Shell Access\nShell changed\nChanging cPanel theme from jupiter to jupiter\nChanging plan from default to boo\nBandwidth limit (unlimited) is lower than (unlimited) (all limits removed)<br /><blockquote><div style='float:left;'>Enabling...</div><div style='float:left;'>...exampleaddon.com...</div><div style='float:left;'>...exampleaddon.example.com...</div><div style='float:left;'>...example.com...</div><div style='float:left;'>Done</div></blockquote><br /><div class='clearit' style='clear:both; width:80%;'> </div>Setting quota to “unlimited”.\n<span class=\"b2\">Warning, this will not change shared IP accounts to dedicated IP accounts, or the reverse.</span>\n<span class=\"b2\">Warning: Changing a user’s package does not affect their Digest Authentication settings.</span>\n</pre>"</span></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">"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/Account-Management/operation/get_upgrade_opportunities" data-section-id="tag/Account-Management/operation/get_upgrade_opportunities" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_upgrade_opportunities" id="operation/get_upgrade_opportunities" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management/operation/get_upgrade_opportunities" aria-label="tag/Account-Management/operation/get_upgrade_opportunities"></a>Get upgrade opportunities<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists accounts that could benefit from upgrading to a different package.
The listed accounts may be nearing (or exceeding) resource usage thresholds.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists accounts that could benefit from upgrading to a different package.
The listed accounts may be nearing (or exceeding) resource usage thresholds.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="disk_threshold_blocks" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">disk_threshold_blocks</span></td><td class="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">2097152</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">disk_threshold_blocks=8388608</span></div><div><div html="<p>A fixed number of blocks to use as an alternative disk usage threshold.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A fixed number of blocks to use as an alternative disk usage threshold.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="nearness_fraction" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nearness_fraction</span></td><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><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> <!-- -->( 0 .. 1 )<!-- --> </span></span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0.8</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">nearness_fraction=0.6</span></div><div><div html="<p>The fraction of 1 at which to consider usage &quot;near&quot;.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The fraction of 1 at which to consider usage "near".</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_upgrade_opportunities</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_upgrade_opportunities</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155i71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155i71a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155i71a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155i71a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155i71a:0" aria-labelledby="tab:R155i71a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_upgrade_opportunities
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155i71a:1" aria-labelledby="tab:R155i71a: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:R175i71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175i71a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175i71a:0" aria-labelledby="tab:R175i71a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"upgrade_opportunities"</span>: <button class="collapser" aria-label="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">"bw_limit"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"last_month"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fraction"</span>: <span class="token number">0.54</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"near"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reached"</span>: <span class="token number">1</span></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>: <button class="collapser" aria-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 account has used 54% of its bandwidth quota for this month."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"this_month"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fraction"</span>: <span class="token number">0.54</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"near"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reached"</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">"disk_usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"This account has used 94% of its disk quota."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"relative_to_fixed_amount"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fraction"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"near"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reached"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"threshold_blocks"</span>: <span class="token number">10485760</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"relative_to_quota"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fraction"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"near"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reached"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"threshold_blocks"</span>: <span class="token number">10485760</span></div></li></ul><span class="token punctuation">}</span></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>: <button class="collapser" aria-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 account has used 54% of its bandwidth quota for this month."</span>,</div></li><li><div class="hoverable "><span class="token string">"This account has used 94% of its disk quota."</span></div></li></ul><span class="token punctuation">]</span></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">"bw_limit"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"last_month"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fraction"</span>: <span class="token number">0.54</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"near"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reached"</span>: <span class="token number">1</span></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>: <button class="collapser" aria-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 account has used 54% of its bandwidth quota for this month."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"this_month"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fraction"</span>: <span class="token number">0.54</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"near"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reached"</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">"disk_usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"This account has used 94% of its disk quota."</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"relative_to_fixed_amount"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fraction"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"near"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reached"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"threshold_blocks"</span>: <span class="token number">10485760</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"relative_to_quota"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fraction"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"near"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reached"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"threshold_blocks"</span>: <span class="token number">10485760</span></div></li></ul><span class="token punctuation">}</span></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>: <button class="collapser" aria-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 account has used 54% of its bandwidth quota for this month."</span>,</div></li><li><div class="hoverable "><span class="token string">"This account has used 94% of its disk quota."</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_upgrade_opportunities"</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/Account-Management/operation/myprivs" data-section-id="tag/Account-Management/operation/myprivs" class="sc-dntaoT ceciOs"><div data-section-id="operation/myprivs" id="operation/myprivs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management/operation/myprivs" aria-label="tag/Account-Management/operation/myprivs"></a>Return cPanel account system privileges<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the current user&#39;s <a href="https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges">Access Control List (ACL)</a> privileges.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the current user's <a href="https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges">Access Control List (ACL)</a> 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/myprivs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/myprivs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155m71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155m71a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155m71a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155m71a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155m71a:0" aria-labelledby="tab:R155m71a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
myprivs
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155m71a:1" aria-labelledby="tab:R155m71a: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:R175m71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175m71a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175m71a:0" aria-labelledby="tab:R175m71a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"privileges"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acct-summary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"add-pkg"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"add-pkg-ip"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"add-pkg-shell"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"all"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow-addoncreate"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow-emaillimits-pkgs"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow-parkedcreate"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow-shell"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow-unlimited-bw-pkgs"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow-unlimited-disk-pkgs"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow-unlimited-pkgs"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"basic-system-info"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"basic-whm-functions"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"clustering"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cors-proxy-get"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpanel-api"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpanel-integration"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create-acct"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create-dns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create-user-session"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"demo-setup"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"digest-auth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit-account"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit-dns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit-mx"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit-pkg"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file-restore"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"generate-email-config"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"kill-acct"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"kill-dns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit-bandwidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"list-accts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"list-pkgs"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale-edit"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailcheck"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"manage-api-tokens"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"manage-dns-records"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"manage-oidc"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"manage-styles"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql-info"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"news"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ns-config"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"park-dns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd"</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">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rearrange-accts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"resftp"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restart"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"show-bandwidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssl"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssl-buy"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssl-gencrt"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssl-info"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stats"</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">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspend-acct"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thirdparty"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"track-email"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"upgrade-account"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"viewglobalpackages"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="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">"myprivs"</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/Account-Management/operation/list_users" data-section-id="tag/Account-Management/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/Account-Management/operation/list_users" aria-label="tag/Account-Management/operation/list_users"></a>Return root and cPanel accounts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the cPanel user accounts and the <code>root</code> user on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the cPanel user accounts and the <code>root</code> user on the 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R155q71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155q71a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155q71a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155q71a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155q71a:0" aria-labelledby="tab:R155q71a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_users
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155q71a:1" aria-labelledby="tab:R155q71a: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:R175q71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175q71a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175q71a:0" aria-labelledby="tab:R175q71a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"example"</span>,</div></li><li><div class="hoverable "><span class="token string">"root"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"list_users"</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/Account-Management/operation/massmodifyacct" data-section-id="tag/Account-Management/operation/massmodifyacct" class="sc-dntaoT ceciOs"><div data-section-id="operation/massmodifyacct" id="operation/massmodifyacct" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management/operation/massmodifyacct" aria-label="tag/Account-Management/operation/massmodifyacct"></a>Update multiple cPanel accounts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function modifies multiple cPanel accounts.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>We <strong>strongly</strong> recommend that you do not modify a cPanel account&#39;s settings
if that account uses a hosting plan (package). If the package values change, the
system will overwrite any of your custom values with the package&#39;s new values.</li>
<li>This function uses case-sensitive parameters. You <strong>must</strong> enter parameters in
the correct case format. If you do not, the function will ignore that parameter.</li>
</ul>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of
SPF resource records on DNS.</p>
<ul>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because
<a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>. CentOS 7
servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated
version of BIND that complies with RFC 7208. To resolve this issue, update your
operating system to a version that contains the updated version of BIND. For more
information, read the <a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies multiple cPanel accounts.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>We <strong>strongly</strong> recommend that you do not modify a cPanel account's settings
if that account uses a hosting plan (package). If the package values change, the
system will overwrite any of your custom values with the package's new values.</li>
<li>This function uses case-sensitive parameters. You <strong>must</strong> enter parameters in
the correct case format. If you do not, the function will ignore that parameter.</li>
</ul>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of
SPF resource records on DNS.</p>
<ul>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because
<a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>. CentOS 7
servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated
version of BIND that complies with RFC 7208. To resolve this issue, update your
operating system to a version that contains the updated version of BIND. For more
information, read the <a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</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">any</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">BACKUP=1</span></div><div><div html="<p>Whether backups are enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>This parameter <strong>requires</strong> <code>root</code> privileges.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether backups are enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>This parameter <strong>requires</strong> <code>root</code> privileges.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="BWLIMIT" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand BWLIMIT"><span class="property-name">BWLIMIT</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->IntPosNullOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">BWLIMIT=unlimited</span></div><div><div html="<p>The account&#39;s maximum bandwidth use, in bytes.</p>
<ul>
<li><code>0</code>, <code>null</code> or <code>unlimited</code> — The account can use unlimited bandwidth.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's maximum bandwidth use, in bytes.</p>
<ul>
<li><code>0</code>, <code>null</code> or <code>unlimited</code> — The account can use unlimited bandwidth.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="CONTACTEMAIL" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">CONTACTEMAIL</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">CONTACTEMAIL=username@example.com</span></div><div><div html="<p>The account&#39;s contact email address.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's contact email address.</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="DBOWNER" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">DBOWNER</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">DBOWNER=example</span></div><div><div html="<p>The owner of the account&#39;s MySQL® databases.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The owner of the account's MySQL® databases.</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="DISK_BLOCK_LIMIT" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">DISK_BLOCK_LIMIT</span></td><td class="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">DISK_BLOCK_LIMIT=100000000</span></div><div><div html="<p>The number of disk blocks for the account, in kilobytes (KB).</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of disk blocks for the account, in kilobytes (KB).</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="HASCGI" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">HASCGI</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">HASCGI=1</span></div><div><div html="<p>Whether CGI access is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>When a <a href="https://go.cpanel.net/whmdocsServerProfile">server profile</a> disables the
<a href="https://go.cpanel.net/serverroles#roles">Web Server</a> role, you <strong>cannot</strong> enable
CGI access.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether CGI access is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>When a <a href="https://go.cpanel.net/whmdocsServerProfile">server profile</a> disables the
<a href="https://go.cpanel.net/serverroles#roles">Web Server</a> role, you <strong>cannot</strong> enable
CGI access.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="HASDKIM" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">HASDKIM</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether DomainKeys Identified Mail (DKIM) is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether DomainKeys Identified Mail (DKIM) is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="HASDMARC" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">HASDMARC</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether Domain-based Message Authentication, Reporting, and Conformance (DMARC) is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether Domain-based Message Authentication, Reporting, and Conformance (DMARC) is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="HASSHELL" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">HASSHELL</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">HASSHELL=1</span></div><div><div html="<p>Whether shell (SSH) access is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>We <strong>strongly</strong> recommend that you use the <code>shell</code> parameter to specify a shell for
SSH access.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether shell (SSH) access is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>We <strong>strongly</strong> recommend that you use the <code>shell</code> parameter to specify a shell for
SSH access.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="HASSPF" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">HASSPF</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">HASSPF=1</span></div><div><div html="<p>Whether Sender Policy Framework (SPF) is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether Sender Policy Framework (SPF) is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="LANG" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">LANG</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">LANG=english-utf8</span></div><div><div html="<p>The account&#39;s display language.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's display language.</p>
<p>This parameter defaults to the defined system value.</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><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">LOCALE=en</span></div><div><div html="<p>The account&#39;s default locale.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's default locale.</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAILBOX_FORMAT" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">MAILBOX_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">any</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"maildir"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mbox"</span> </div> <div><div html="<p>The storage format that the account&#39;s mailboxes use.</p>
<ul>
<li><code>maildir</code></li>
<li><code>mbox</code></li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The storage format that the account's mailboxes use.</p>
<ul>
<li><code>maildir</code></li>
<li><code>mbox</code></li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAX_DEFER_FAIL_PERCENTAGE" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAX_DEFER_FAIL_PERCENTAGE"><span class="property-name">MAX_DEFER_FAIL_PERCENTAGE</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->IntPosOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAX_DEFER_FAIL_PERCENTAGE=unlimited</span></div><div><div html="<p>The percentage of failed or deferred email messages that the account can send per hour
before outgoing mail is rate-limited.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The account can send an unlimited number of failed or deferred
messages.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The percentage of failed or deferred email messages that the account can send per hour
before outgoing mail is rate-limited.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The account can send an unlimited number of failed or deferred
messages.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAX_EMAIL_PER_HOUR" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAX_EMAIL_PER_HOUR"><span class="property-name">MAX_EMAIL_PER_HOUR</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->IntPosOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAX_EMAIL_PER_HOUR=unlimited</span></div><div><div html="<p>The maximum number of emails that the account can send in one hour.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The account can send an unlimited number of emails.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of emails that the account can send in one hour.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The account can send an unlimited number of emails.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAX_EMAILACCT_QUOTA" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAX_EMAILACCT_QUOTA"><span class="property-name">MAX_EMAILACCT_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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAX_EMAILACCT_QUOTA=unlimited</span></div><div><div html="<p>The maximum size, in megabytes (MB), that the account can define when it creates an
email account.</p>
<ul>
<li><code>unlimited</code> — The account possesses an unlimited quota.</li>
</ul>
<p><strong>Important:</strong></p>
<ul>
<li>This value applies to each email account, <strong>not</strong> each cPanel account.</li>
<li>If you specify a <code>MAX_EMAILACCT_QUOTA</code> value, the function will <strong>overwrite</strong> the
plan&#39;s defined value for that cPanel account.</li>
<li>This parameter does <strong>not</strong> affect any existing email accounts</li>
<li>We recommend that you allow the account&#39;s plan to determine this value.</li>
<li><code>MAX_EMAIL_PER_HOUR</code> will define to unlimited if you do <strong>not</strong> define either the plan
or <code>MAX_EMAILACCT_QUOTA</code> parameters.</li>
</ul>
<p>This parameter defaults to the defined system value. It will default to <code>unlimited</code> if
you do <strong>not</strong> define either the <code>plan</code> or <code>MAX_EMAILACCT_QUOTA</code> parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum size, in megabytes (MB), that the account can define when it creates an
email account.</p>
<ul>
<li><code>unlimited</code> — The account possesses an unlimited quota.</li>
</ul>
<p><strong>Important:</strong></p>
<ul>
<li>This value applies to each email account, <strong>not</strong> each cPanel account.</li>
<li>If you specify a <code>MAX_EMAILACCT_QUOTA</code> value, the function will <strong>overwrite</strong> the
plan's defined value for that cPanel account.</li>
<li>This parameter does <strong>not</strong> affect any existing email accounts</li>
<li>We recommend that you allow the account's plan to determine this value.</li>
<li><code>MAX_EMAIL_PER_HOUR</code> will define to unlimited if you do <strong>not</strong> define either the plan
or <code>MAX_EMAILACCT_QUOTA</code> parameters.</li>
</ul>
<p>This parameter defaults to the defined system value. It will default to <code>unlimited</code> if
you do <strong>not</strong> define either the <code>plan</code> or <code>MAX_EMAILACCT_QUOTA</code> parameters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXADDON" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXADDON"><span class="property-name">MAXADDON</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int0-999999NullOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXADDON=unlimited</span></div><div><div html="<p>The account&#39;s maximum number of addon domains.</p>
<ul>
<li><code>0</code>, <code>null</code>, or <code>unlimited</code> — The account possesses unlimited addon domains.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's maximum number of addon domains.</p>
<ul>
<li><code>0</code>, <code>null</code>, or <code>unlimited</code> — The account possesses unlimited addon domains.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXFTP" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXFTP"><span class="property-name">MAXFTP</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int0-999999NullOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXFTP=unlimited</span></div><div><div html="<p>The account&#39;s maximum number of FTP accounts.</p>
<ul>
<li><code>null</code> or <code>unlimited</code> — The account possesses unlimited FTP accounts.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's maximum number of FTP accounts.</p>
<ul>
<li><code>null</code> or <code>unlimited</code> — The account possesses unlimited FTP accounts.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXLST" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXLST"><span class="property-name">MAXLST</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int0-999999NullOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXLST=unlimited</span></div><div><div html="<p>The account&#39;s maximum number of mailing lists.</p>
<ul>
<li><code>0</code>, <code>null</code>, or <code>unlimited</code> — The account possesses unlimited mailing lists.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's maximum number of mailing lists.</p>
<ul>
<li><code>0</code>, <code>null</code>, or <code>unlimited</code> — The account possesses unlimited mailing lists.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXPARK" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXPARK"><span class="property-name">MAXPARK</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int0-999999NullOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXPARK=unlimited</span></div><div><div html="<p>The account&#39;s maximum number of parked domains (aliases).</p>
<ul>
<li><code>null</code> or <code>unlimited</code> — The account possesses unlimited mailing lists.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's maximum number of parked domains (aliases).</p>
<ul>
<li><code>null</code> or <code>unlimited</code> — The account possesses unlimited mailing lists.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXPASSENGERAPPS" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXPASSENGERAPPS"><span class="property-name">MAXPASSENGERAPPS</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int0-999999NullOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXPASSENGERAPPS=unlimited</span></div><div><div html="<p>The account&#39;s maximum number of Ruby applications.</p>
<ul>
<li><code>null</code> or <code>unlimited</code> — The account possesses unlimited Ruby applications.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's maximum number of Ruby applications.</p>
<ul>
<li><code>null</code> or <code>unlimited</code> — The account possesses unlimited Ruby applications.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXPOP" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXPOP"><span class="property-name">MAXPOP</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int0-999999NullOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXPOP=unlimited</span></div><div><div html="<p>The maximum number of email accounts for the account.</p>
<ul>
<li><code>null</code> or <code>unlimited</code> — The account possesses unlimited email accounts.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of email accounts for the account.</p>
<ul>
<li><code>null</code> or <code>unlimited</code> — The account possesses unlimited email accounts.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXSQL" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXSQL"><span class="property-name">MAXSQL</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int0Max999999NullOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXSQL=unlimited</span></div><div><div html="<p>The maximum number of each available type of SQL database for the account.</p>
<p>For example, if you set this value to <code>5</code> and the system administrator allows MySQL®
and PostgreSQL® databases, users can create up to five MySQL databases and up to five
PostgreSQL databases.</p>
<ul>
<li><code>null</code> or <code>unlimited</code> — The account possesses unlimited databases.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of each available type of SQL database for the account.</p>
<p>For example, if you set this value to <code>5</code> and the system administrator allows MySQL®
and PostgreSQL® databases, users can create up to five MySQL databases and up to five
PostgreSQL databases.</p>
<ul>
<li><code>null</code> or <code>unlimited</code> — The account possesses unlimited databases.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXSUB" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXSUB"><span class="property-name">MAXSUB</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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 or string or integer</span><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Int0-999999NullOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXSUB=unlimited</span></div><div><div html="<p>The maximum number of subdomains for the account.</p>
<ul>
<li><code>null</code> or <code>unlimited</code> — The account possesses unlimited subdomains.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of subdomains for the account.</p>
<ul>
<li><code>null</code> or <code>unlimited</code> — The account possesses unlimited subdomains.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="modify_firewall" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">modify_firewall</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">modify_firewall=0</span></div><div><div html="<p>Whether to modify the firewall rules as part of the account modification.</p>
<ul>
<li><code>1</code> – Modify the firewall rules.</li>
<li><code>0</code> – Do <strong>not</strong> modify the firewall rules.</li>
</ul>
<p><strong>NOTE:</strong></p>
<p>If you do not set this parameter, the system will modify the firewall based on the <em>Do not make changes to the firewall during account modification.</em> setting in WHM&#39;s <a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/"><em>Tweak Settings</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to modify the firewall rules as part of the account modification.</p>
<ul>
<li><code>1</code> – Modify the firewall rules.</li>
<li><code>0</code> – Do <strong>not</strong> modify the firewall rules.</li>
</ul>
<p><strong>NOTE:</strong></p>
<p>If you do not set this parameter, the system will modify the firewall based on the <em>Do not make changes to the firewall during account modification.</em> setting in WHM's <a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/"><em>Tweak Settings</em></a> interface (<em>WHM >> Home >> Server Configuration >> Tweak Settings</em>).</p>
</div></div></div></td></tr><tr class=""><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">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">MXCHECK-*=1</span></div><div><div html="<p>The priority of the account&#39;s primary mail exchanger.</p>
<p><strong>Note:</strong></p>
<p>The parameter name consists of <code>MXCHECK</code>, a hyphen, and the primary domain of the
account.</p>
<p>Example key and value:</p>
<ul>
<li><code>MXCHECK-example.com=10</code></li>
</ul>
<p>This parameter defaults to the define system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The priority of the account's primary mail exchanger.</p>
<p><strong>Note:</strong></p>
<p>The parameter name consists of <code>MXCHECK</code>, a hyphen, and the primary domain of the
account.</p>
<p>Example key and value:</p>
<ul>
<li><code>MXCHECK-example.com=10</code></li>
</ul>
<p>This parameter defaults to the define system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_account_authn_link" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_account_authn_link</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_account_authn_link=0</span></div><div><div html="<p>Whether to send a notification when someone links the account to an external
authentication account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when someone links the account to an external
authentication account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_account_authn_link_notification_disabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_account_authn_link_notification_disabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_account_authn_link_notification_disabled=0</span></div><div><div html="<p>Whether to send a notification when someone disables notifications for external
authentication account links.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when someone disables notifications for external
authentication account links.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_autossl_expiry" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_autossl_expiry</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_autossl_expiry=0</span></div><div><div html="<p>Whether to send a notification when an AutoSSL certificate expires.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when an AutoSSL certificate expires.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_autossl_expiry_coverage" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_autossl_expiry_coverage</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_autossl_expiry_coverage=0</span></div><div><div html="<p>Whether to send a notification AutoSSL cannot renew a certificate because domains
that fail Domain Control Validation (DCV) exist on the current certificate.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification AutoSSL cannot renew a certificate because domains
that fail Domain Control Validation (DCV) exist on the current certificate.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_autossl_renewal" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_autossl_renewal</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_autossl_renewal=0</span></div><div><div html="<p>Whether to send a notification when AutoSSL renews a certificate.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when AutoSSL renews a certificate.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_autossl_renewal_coverage" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_autossl_renewal_coverage</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_autossl_renewal_coverage=0</span></div><div><div html="<p>Whether to send a notification when AutoSSL renews a certificate but the new
certificate lacks at least one domain that the previous certificate secured.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when AutoSSL renews a certificate but the new
certificate lacks at least one domain that the previous certificate secured.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_contact_address_change" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_contact_address_change</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_contact_address_change=0</span></div><div><div html="<p>Whether to send a notification when someone changes the contact address for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when someone changes the contact address for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_contact_address_change_notification_disabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_contact_address_change_notification_disabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_contact_address_change_notification_disabled=0</span></div><div><div html="<p>Whether to send a notification when disables the notification for contact address
changes.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when disables the notification for contact address
changes.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_disk_limit" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_disk_limit</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_disk_limit=0</span></div><div><div html="<p>Whether to send a notification when the account reaches its disk usage limit.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when the account reaches its disk usage limit.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_password_change" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_password_change</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_password_change=0</span></div><div><div html="<p>Whether to send a notification when someone changes the account&#39;s password.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when someone changes the account's password.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_password_change_notification_disabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_password_change_notification_disabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_password_change_notification_disabled=0</span></div><div><div html="<p>Whether to send a notification when someone disables notifications for password changes.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when someone disables notifications for password changes.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_ssl_expiry" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_ssl_expiry</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_ssl_expiry=0</span></div><div><div html="<p>Whether to send a notification when an SSL certificate on the account expires.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a notification when an SSL certificate on the account expires.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="OUTGOING_EMAIL_SUSPENDED" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">OUTGOING_EMAIL_SUSPENDED</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">OUTGOING_EMAIL_SUSPENDED=0</span></div><div><div html="<p>Whether to suspend outgoing email on the account.</p>
<ul>
<li><code>1</code> — Suspend outgoing email.</li>
<li><code>0</code> — Do <strong>not</strong> suspend outgoing email.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to suspend outgoing email on the account.</p>
<ul>
<li><code>1</code> — Suspend outgoing email.</li>
<li><code>0</code> — Do <strong>not</strong> suspend outgoing email.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="OWNER" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">OWNER</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">OWNER=reseller</span></div><div><div html="<p>A new owner&#39;s username or the <code>root</code> user, to change the account&#39;s owner.</p>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>The authenticated user <strong>must</strong> have <code>root</code> privileges in order to assign the account
to a reseller other than that account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A new owner's username or the <code>root</code> user, to change the account's owner.</p>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>The authenticated user <strong>must</strong> have <code>root</code> privileges in order to assign the account
to a reseller other than that account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="PUSHBULLET_ACCESS_TOKEN" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">PUSHBULLET_ACCESS_TOKEN</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">PUSHBULLET_ACCESS_TOKEN=1234567890</span></div><div><div html="<p>An access token for the account&#39;s <a href="https://www.pushbullet.com/">Pushbullet</a>™
notifications.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An access token for the account's <a href="https://www.pushbullet.com/">Pushbullet</a>™
notifications.</p>
<p>This parameter defaults to the defined system value.</p>
</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">any or string or integer</span><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->IntPosNullOrUnlimited<!-- -->) </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">QUOTA=unlimited</span></div><div><div html="<p>The account&#39;s disk space quota, in multiples of 1,048,576 bytes.</p>
<ul>
<li><code>0</code>, <code>null</code>, or <code>unlimited</code> — The account&#39;s disk space is unlimited.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's disk space quota, in multiples of 1,048,576 bytes.</p>
<ul>
<li><code>0</code>, <code>null</code>, or <code>unlimited</code> — The account's disk space is unlimited.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="remove_missing_extensions" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">remove_missing_extensions</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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_missing_extensions=packageext1 packageext2</span></div><div><div html="<p>A space-separated list of removed, missing, or uninstalled extensions.</p>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Warning:</strong></p>
<p>This parameter removes all of the extensions that you list from
the <code>_PACKAGE_EXTENSIONS</code> variable in the user file. It will <strong>not</strong> remove the
extensions&#39; variables. For more information, read our
<a href="https://go.cpanel.net/GuidetoPackageExtensions">Guide to Package Extensions</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A space-separated list of removed, missing, or uninstalled extensions.</p>
<p>This parameter defaults to the defined system value.</p>
<p><strong>Warning:</strong></p>
<p>This parameter removes all of the extensions that you list from
the <code>_PACKAGE_EXTENSIONS</code> variable in the user file. It will <strong>not</strong> remove the
extensions' variables. For more information, read our
<a href="https://go.cpanel.net/GuidetoPackageExtensions">Guide to Package Extensions</a>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="rename_database_objects" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">rename_database_objects</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">rename_database_objects=0</span></div><div><div html="<p>Whether to rename the cPanel account&#39;s database objects to use a new username&#39;s
database prefix. This parameter <strong>only</strong> applies to servers that use database prefixing.</p>
<ul>
<li><code>1</code> — Rename the cPanel account&#39;s database objects.</li>
<li><code>0</code> — Do <strong>not</strong> rename the cPanel account&#39;s database objects.</li>
</ul>
<p><strong>Warning:</strong></p>
<ul>
<li>The account owner <strong>must</strong> update any applications to use the new database object names.</li>
<li><strong>Use this parameter carefully</strong>. It can cause confusion for system administrators.</li>
</ul>
<p>MySQL does <strong>not</strong> 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>If <strong>any</strong> 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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to rename the cPanel account's database objects to use a new username's
database prefix. This parameter <strong>only</strong> applies to servers that use database prefixing.</p>
<ul>
<li><code>1</code> — Rename the cPanel account's database objects.</li>
<li><code>0</code> — Do <strong>not</strong> rename the cPanel account's database objects.</li>
</ul>
<p><strong>Warning:</strong></p>
<ul>
<li>The account owner <strong>must</strong> update any applications to use the new database object names.</li>
<li><strong>Use this parameter carefully</strong>. It can cause confusion for system administrators.</li>
</ul>
<p>MySQL does <strong>not</strong> 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>If <strong>any</strong> 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>
</div></div></div></td></tr><tr class=""><td kind="field" title="reseller" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">reseller</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">reseller=1</span></div><div><div html="<p>Whether to grant reseller privileges to the account.</p>
<ul>
<li><code>1</code> — Grant reseller privileges.</li>
<li><code>0</code> — Do <strong>not</strong> grant reseller privileges.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to grant reseller privileges to the account.</p>
<ul>
<li><code>1</code> — Grant reseller privileges.</li>
<li><code>0</code> — Do <strong>not</strong> grant reseller privileges.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="RS" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">RS</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">RS=jupiter</span></div><div><div html="<p>The account&#39;s cPanel interface theme.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's cPanel interface theme.</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="shell" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">shell</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">shell=/bin/bash</span></div><div><div html="<p>The absolute file path to the shell&#39;s location.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute file path to the shell's location.</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="spamassassin" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">spamassassin</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">spamassassin=1</span></div><div><div html="<p>Whether Apache SpamAssassin™ is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether Apache SpamAssassin™ is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="STARTDATE" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">STARTDATE</span></td><td class="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">STARTDATE=1549471343</span></div><div><div html="<p>A timestamp for which to use as the account&#39;s creation date.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A timestamp for which to use as the account's creation date.</p>
<p>This parameter defaults to the defined system value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="STYLE" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">STYLE</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">STYLE=Glass</span></div><div><div html="<p>The account&#39;s cPanel interface style.</p>
<p>This parameter defaults to the defined system value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's cPanel interface style.</p>
<p>This parameter defaults to the defined system value.</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> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=user-0=username user-1=username1 user-2=username2 user-3=username3</span> -<!-- --> <!-- -->Modify multiple users.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=user=username user=username1 user=username2 user=username3</span> -<!-- --> <!-- -->Modify multiple users.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=username</span> -<!-- --> <!-- -->Modify a single user.</li></ul><div><div html="<p>The account&#39;s current username.</p>
<p><strong>Note:</strong></p>
<p>To modify multiple users, duplicate or increment the parameter name. For example,
the <code>user-1</code>, <code>user-2</code>, and <code>user-3</code> parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's current username.</p>
<p><strong>Note:</strong></p>
<p>To modify multiple users, duplicate or increment the parameter name. For example,
the <code>user-1</code>, <code>user-2</code>, and <code>user-3</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/massmodifyacct</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/massmodifyacct</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155u71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155u71a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155u71a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155u71a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155u71a:0" aria-labelledby="tab:R155u71a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
massmodifyacct <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R155u71a:1" aria-labelledby="tab:R155u71a: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:R175u71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175u71a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175u71a:0" aria-labelledby="tab:R175u71a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"Unable to fetch the cPanel user file for username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <span class="token number">0</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><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"extended"</span>: <button class="collapser" aria-label="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"</span>: <button class="collapser" aria-label="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"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"BWLIMIT"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CONTACTEMAIL"</span>: <span class="token string">"username1@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CONTACTEMAIL2"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DBOWNER"</span>: <span class="token string">"username1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DEADDOMAINS"</span>: <button class="collapser" aria-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.example1.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"</span>: <span class="token string">"0"</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">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DOMAIN"</span>: <span class="token string">"example1.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DOMAINS"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FEATURELIST"</span>: <span class="token string">"default"</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">"HASDKIM"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASDMARC"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASSPF"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HOMEDIRLINKS"</span>: <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">"172.16.1.3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"LANG"</span>: <span class="token string">"english-utf8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"LEGACY_BACKUP"</span>: <span class="token string">"0"</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">"MAXADDON"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXFTP"</span>: <span class="token string">"234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXLST"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPARK"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPOP"</span>: <span class="token string">"123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSQL"</span>: <span class="token string">"345"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSUB"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_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">"MAX_EMAILACCT_QUOTA"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_EMAIL_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">"MTIME"</span>: <span class="token string">"1584509675"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MXCHECK-example1.com"</span>: <span class="token string">"remote"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"OWNER"</span>: <span class="token string">"username1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"PLAN"</span>: <span class="token string">"extended"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"RS"</span>: <span class="token string">"jupiter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"STARTDATE"</span>: <span class="token string">"765435600"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"USER"</span>: <span class="token string">"username1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"UTF8MAILBOX"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"WORKER_NODE-Mail"</span>: <span class="token string">"example1:6L3ZJZ8LPAAOMC8CA31325O8EKGJ5YV5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_PACKAGE_EXTENSIONS"</span>: <span class="token string">"custom"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"__CACHE_DATA_VERSION"</span>: <span class="token string">"0.81"</span></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">"example1.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setshell"</span>: <span class="token string">"unmodified"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"username1"</span></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 punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Account Modified"</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">"user"</span>: <span class="token string">"username1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"extended"</span>: <button class="collapser" aria-label="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"</span>: <button class="collapser" aria-label="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"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"BWLIMIT"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CONTACTEMAIL"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CONTACTEMAIL2"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DBOWNER"</span>: <span class="token string">"username2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DEADDOMAINS"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DEMO"</span>: <span class="token string">"0"</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">0</span><span class="token punctuation">,</span></div></li><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">"DOMAINS"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FEATURELIST"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASCGI"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASDKIM"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASDMARC"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASSPF"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HOMEDIRLINKS"</span>: <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">"10.0.0.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"LANG"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"LEGACY_BACKUP"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"LOCALE"</span>: <span class="token string">"cs"</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">"MAXADDON"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXFTP"</span>: <span class="token string">"234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXLST"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPARK"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPOP"</span>: <span class="token string">"123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSQL"</span>: <span class="token string">"345"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSUB"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_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">"MAX_EMAILACCT_QUOTA"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_EMAIL_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">"MTIME"</span>: <span class="token string">"1583966719"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MXCHECK-example2.com"</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">"PLAN"</span>: <span class="token string">"extended"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"RS"</span>: <span class="token string">"jupiter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"STARTDATE"</span>: <span class="token string">"728719200"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"USER"</span>: <span class="token string">"username2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"UTF8MAILBOX"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"WORKER_NODE-Mail"</span>: <span class="token string">"example2:BXE4LIAXF4X9N0B0TG69AAQ64DGR1XPU"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_PACKAGE_EXTENSIONS"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"__CACHE_DATA_VERSION"</span>: <span class="token string">"0.81"</span></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">"example2.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setshell"</span>: <span class="token string">"unmodified"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"username2"</span></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 punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxied_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">"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">"reason"</span>: <span class="token string">"Account Modified"</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">"user"</span>: <span class="token string">"username2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"extended"</span>: <button class="collapser" aria-label="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"</span>: <button class="collapser" aria-label="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"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"BWLIMIT"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CONTACTEMAIL"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CONTACTEMAIL2"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DBOWNER"</span>: <span class="token string">"username2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DEADDOMAINS"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DEMO"</span>: <span class="token number">0</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">0</span><span class="token punctuation">,</span></div></li><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">"DOMAINS"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FEATURELIST"</span>: <span class="token string">"default"</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">"HASDKIM"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASDMARC"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASSPF"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HOMEDIRLINKS"</span>: <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">"172.16.1.3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"LANG"</span>: <span class="token string">"english-utf8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"LEGACY_BACKUP"</span>: <span class="token string">"0"</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">"MAXADDON"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXFTP"</span>: <span class="token string">"234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXLST"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPARK"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPOP"</span>: <span class="token string">"123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSQL"</span>: <span class="token string">"345"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSUB"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_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">"MAX_EMAILACCT_QUOTA"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_EMAIL_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">"MTIME"</span>: <span class="token string">"1584509675"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MXCHECK-example2.com"</span>: <span class="token string">"remote"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"OWNER"</span>: <span class="token string">"username2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"PLAN"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"RS"</span>: <span class="token string">"jupiter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"STARTDATE"</span>: <span class="token string">"765435600"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"USER"</span>: <span class="token string">"username2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"UTF8MAILBOX"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"WORKER_NODE-Mail"</span>: <span class="token string">"example2:H99IZWY3OH9Q1DQNR58L55WUBXAENPDP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_PACKAGE_EXTENSIONS"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"__CACHE_DATA_VERSION"</span>: <span class="token string">"0.81"</span></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">"example2.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setshell"</span>: <span class="token string">"unmodified"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"username2"</span></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 punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Account Modified"</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">"user"</span>: <span class="token string">"username2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"extended"</span>: <button class="collapser" aria-label="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"</span>: <button class="collapser" aria-label="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"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"BWLIMIT"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CONTACTEMAIL"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CONTACTEMAIL2"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DBOWNER"</span>: <span class="token string">"username2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DEADDOMAINS"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DEMO"</span>: <span class="token number">0</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">0</span><span class="token punctuation">,</span></div></li><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">"DOMAINS"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FEATURELIST"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASCGI"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASDKIM"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASDMARC"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASSPF"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HOMEDIRLINKS"</span>: <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">"10.0.0.2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"LANG"</span>: <span class="token string">"english-utf8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"LEGACY_BACKUP"</span>: <span class="token string">"0"</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">"MAXADDON"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXFTP"</span>: <span class="token string">"234"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXLST"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPARK"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPOP"</span>: <span class="token string">"123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSQL"</span>: <span class="token string">"345"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSUB"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_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">"MAX_EMAILACCT_QUOTA"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_EMAIL_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">"MTIME"</span>: <span class="token string">"1583966717"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MXCHECK-example2.com"</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">"linked"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"PLAN"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"RS"</span>: <span class="token string">"jupiter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"STARTDATE"</span>: <span class="token string">"765435600"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"USER"</span>: <span class="token string">"username2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"UTF8MAILBOX"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_PACKAGE_EXTENSIONS"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"__CACHE_DATA_VERSION"</span>: <span class="token string">"0.81"</span></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">"example2.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setshell"</span>: <span class="token string">"noshell"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"username2"</span></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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"Shell changed"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxied_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">"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">"reason"</span>: <span class="token string">"Account Modified"</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">"user"</span>: <span class="token string">"username2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <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">"metadata"</span>: <button class="collapser" aria-label="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">"massmodifyacct"</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">"From example1.com: Restarting apache"</span></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">"Failed to modify one or more users."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</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 number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Account-Management/operation/accountsummary" data-section-id="tag/Account-Management/operation/accountsummary" class="sc-dntaoT ceciOs"><div data-section-id="operation/accountsummary" id="operation/accountsummary" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management/operation/accountsummary" aria-label="tag/Account-Management/operation/accountsummary"></a>Return cPanel account summary<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves a summary of a user&#39;s account.</p>
<p><strong>Note:</strong></p>
<p>You must use either the user or domain parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a summary of a user's account.</p>
<p><strong>Note:</strong></p>
<p>You must use either the user or domain 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="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 account&#39;s main domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's main 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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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 account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/accountsummary</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/accountsummary</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R156271a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156271a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156271a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156271a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156271a:0" aria-labelledby="tab:R156271a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
accountsummary <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R156271a:1" aria-labelledby="tab:R156271a: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:R176271a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176271a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176271a:0" aria-labelledby="tab:R176271a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acct"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"child_nodes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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 string">"nodealias"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"workload"</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">"disklimit"</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 string">"14M"</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">"username@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inodeslimit"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inodesused"</span>: <span class="token number">1</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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"0101:ca75:0101:ca75:0101:ca75:0101:ca77"</span></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_locked"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"legacy_backup"</span>: <span class="token number">0</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">"max_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">"max_email_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">"max_emailacct_quota"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxaddons"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxftp"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxlst"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxparked"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxpop"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxsql"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxsub"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"min_defer_fail_to_trigger_protection"</span>: <span class="token string">"5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"outgoing_mail_hold"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"outgoing_mail_suspended"</span>: <span class="token number">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">"partition"</span>: <span class="token string">"home"</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">"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">"startdate"</span>: <span class="token string">"13 May 22 16:03"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspended"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspendreason"</span>: <span class="token string">"not suspended"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspendtime"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"temporary"</span>: <span class="token number">0</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">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"unix_startdate"</span>: <span class="token number">1369256589</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></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">"command"</span>: <span class="token string">"accountsummary"</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/Bandwidth-and-Disk-Quotas" data-section-id="tag/Bandwidth-and-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/Bandwidth-and-Disk-Quotas" aria-label="tag/Bandwidth-and-Disk-Quotas"></a>Bandwidth and Disk Quotas</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Accounts / Bandwidth and Disk Quotas</p>
"><p>Accounts / Bandwidth and Disk Quotas</p>
</div></div></div><div id="tag/Bandwidth-and-Disk-Quotas/operation/limitbw" data-section-id="tag/Bandwidth-and-Disk-Quotas/operation/limitbw" class="sc-dntaoT ceciOs"><div data-section-id="operation/limitbw" id="operation/limitbw" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Bandwidth-and-Disk-Quotas/operation/limitbw" aria-label="tag/Bandwidth-and-Disk-Quotas/operation/limitbw"></a>Update cPanel account bandwidth quota<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function modifies a cPanel account&#39;s bandwidth quota.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies a cPanel account's bandwidth 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="bwlimit" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand bwlimit"><span class="property-name">bwlimit</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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">"unlimited"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">bwlimit=0</span></div><div><div html="<p>The account&#39;s new bandwidth quota, in megabytes (MB).</p>
<ul>
<li><code>0</code> and <code>unlimited</code> - Grant the user unlimited bandwidth</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's new bandwidth quota, in megabytes (MB).</p>
<ul>
<li><code>0</code> and <code>unlimited</code> - Grant the user unlimited bandwidth</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=username</span></div><div><div html="<p>The username of a cPanel account on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of a cPanel account on the 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/limitbw</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/limitbw</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99691a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99691a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99691a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99691a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99691a:0" aria-labelledby="tab:R99691a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
limitbw <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R99691a:1" aria-labelledby="tab:R99691a: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:R9p691a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p691a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p691a:0" aria-labelledby="tab:R9p691a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"bwlimits"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"bwlimit"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bwlimitenable"</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><li><div class="hoverable "><span class="token string">"addondomain.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"subdomain.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">"human_bwlimit"</span>: <span class="token string">"500 MB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"human_bwused"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"unlimited"</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">"metadata"</span>: <button class="collapser" aria-label="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">"limitbw"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Bandwidth Limit for username has been set to unlimited megabytes"</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/Bandwidth-and-Disk-Quotas/operation/get_disk_usage" data-section-id="tag/Bandwidth-and-Disk-Quotas/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/Bandwidth-and-Disk-Quotas/operation/get_disk_usage" aria-label="tag/Bandwidth-and-Disk-Quotas/operation/get_disk_usage"></a>Return all cPanel accounts disk usage<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the disk usage status of the system&#39;s user accounts. This also lists information about file system object (inode) usage.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the disk usage status of the system's user accounts. This also lists information about file system object (inode) usage.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="cache_mode" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cache_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">"on"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"on"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"off"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cache_mode=on</span></div><div><div html="<p>Each cPanel &amp; WHM server maintains a cache of users’ disk quota
usage. This parameter controls the way this function will use
that cache.</p>
<ul>
<li><code>on</code> - Use the quota cache. This is fast, but it may be inaccurate.</li>
<li><code>off</code> - Ignore the quota cache. This is slower, but it will be more accurate.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Each cPanel & WHM server maintains a cache of users’ disk quota
usage. This parameter controls the way this function will use
that cache.</p>
<ul>
<li><code>on</code> - Use the quota cache. This is fast, but it may be inaccurate.</li>
<li><code>off</code> - Ignore the quota cache. This is slower, but it will be more accurate.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99a91a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99a91a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99a91a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99a91a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99a91a:0" aria-labelledby="tab:R99a91a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_disk_usage
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99a91a:1" aria-labelledby="tab:R99a91a: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:R9pa91a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pa91a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pa91a:0" aria-labelledby="tab:R9pa91a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"blocks_limit"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"blocks_used"</span>: <span class="token number">2632</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inodes_limit"</span>: <span class="token number">9999</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inodes_used"</span>: <span class="token number">340</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></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">"command"</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">"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/Bandwidth-and-Disk-Quotas/operation/quota_enabled" data-section-id="tag/Bandwidth-and-Disk-Quotas/operation/quota_enabled" class="sc-dntaoT ceciOs"><div data-section-id="operation/quota_enabled" id="operation/quota_enabled" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Bandwidth-and-Disk-Quotas/operation/quota_enabled" aria-label="tag/Bandwidth-and-Disk-Quotas/operation/quota_enabled"></a>Validate cPanel account quotas<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks if quotas are enabled on at least one of a user&#39;s /home directory mounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks if quotas are enabled on at least one of a user's /home directory mounts.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/quota_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/quota_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:R99e91a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99e91a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99e91a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99e91a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99e91a:0" aria-labelledby="tab:R99e91a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
quota_enabled
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99e91a:1" aria-labelledby="tab:R99e91a: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:R9pe91a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pe91a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pe91a:0" aria-labelledby="tab:R9pe91a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"quota_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">"metadata"</span>: <button class="collapser" aria-label="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">"quota_enabled"</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/Bandwidth-and-Disk-Quotas/operation/showbw" data-section-id="tag/Bandwidth-and-Disk-Quotas/operation/showbw" class="sc-dntaoT ceciOs"><div data-section-id="operation/showbw" id="operation/showbw" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Bandwidth-and-Disk-Quotas/operation/showbw" aria-label="tag/Bandwidth-and-Disk-Quotas/operation/showbw"></a>Return cPanel account bandwidth information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves account bandwidth information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves account bandwidth 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="month" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">month</span></td><td class="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 .. 12 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">month=12</span></div><div><div html="<p>The month to query, in numeric format.</p>
<p>This value defaults to the current month.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The month to query, in numeric format.</p>
<p>This value defaults to the current month.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="search" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">search</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">search=ownername</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. The system matches the PCRE against the <code>searchtype</code>
parameter&#39;s specified type.</p>
<p>If you do <strong>not</strong> specify a value for <strong>both</strong> the <code>searchtype</code> and <code>search</code>
parameters, the function does <strong>not</strong> use the <code>search</code> criteria.</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. The system matches the PCRE against the <code>searchtype</code>
parameter's specified type.</p>
<p>If you do <strong>not</strong> specify a value for <strong>both</strong> the <code>searchtype</code> and <code>search</code>
parameters, the function does <strong>not</strong> use the <code>search</code> criteria.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="searchtype" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">searchtype</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"domain"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"owner"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"user"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ip"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"package"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">searchtype=owner</span></div><div><div html="<p>The account information to query.</p>
<ul>
<li><code>domain</code> — Match domains against the <code>search</code> regular expression.</li>
<li><code>owner</code> — Match the WHM user who owns the account against the <code>search</code>
regular expression.</li>
<li><code>user</code> — Match usernames against the <code>search</code> regular expression.</li>
<li><code>ip</code> — Match IP addresses against the <code>search</code> regular expression.</li>
<li><code>package</code> — Match hosting plans (packages) against the <code>search</code> regular
expression.</li>
</ul>
<p>If you do <strong>not</strong> specify a value for <strong>both</strong> the <code>searchtype</code> and <code>search</code>
parameters, the function does <strong>not</strong> use the <code>searchtype</code> value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account information to query.</p>
<ul>
<li><code>domain</code> — Match domains against the <code>search</code> regular expression.</li>
<li><code>owner</code> — Match the WHM user who owns the account against the <code>search</code>
regular expression.</li>
<li><code>user</code> — Match usernames against the <code>search</code> regular expression.</li>
<li><code>ip</code> — Match IP addresses against the <code>search</code> regular expression.</li>
<li><code>package</code> — Match hosting plans (packages) against the <code>search</code> regular
expression.</li>
</ul>
<p>If you do <strong>not</strong> specify a value for <strong>both</strong> the <code>searchtype</code> and <code>search</code>
parameters, the function does <strong>not</strong> use the <code>searchtype</code> value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="showres" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">showres</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">showres=reseller_user</span></div><div><div html="<p>The reseller to query.</p>
<p>If you do <strong>not</strong> specify a value, the function queries <strong>all</strong> users.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller to query.</p>
<p>If you do <strong>not</strong> specify a value, the function queries <strong>all</strong> users.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="year" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">year</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">year=2019</span></div><div><div html="<p>The year to query.</p>
<p>This value defaults to the current year.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The year to query.</p>
<p>This value defaults to the current year.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/showbw</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/showbw</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99i91a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99i91a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99i91a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99i91a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99i91a:0" aria-labelledby="tab:R99i91a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
showbw
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99i91a:1" aria-labelledby="tab:R99i91a: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:R9pi91a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pi91a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pi91a:0" aria-labelledby="tab:R9pi91a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acct"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"bwusage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">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">"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">"deleted"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maindomain"</span>: <span class="token string">"example.com"</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">"reseller"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalbytes"</span>: <span class="token number">352</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">"month"</span>: <span class="token number">12</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reseller"</span>: <span class="token string">"root"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalused"</span>: <span class="token number">352</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"year"</span>: <span class="token number">2019</span></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">"command"</span>: <span class="token string">"showbw"</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/Bandwidth-and-Disk-Quotas/operation/editquota" data-section-id="tag/Bandwidth-and-Disk-Quotas/operation/editquota" class="sc-dntaoT ceciOs"><div data-section-id="operation/editquota" id="operation/editquota" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Bandwidth-and-Disk-Quotas/operation/editquota" aria-label="tag/Bandwidth-and-Disk-Quotas/operation/editquota"></a>Update cPanel account disk quota<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function modifies a user&#39;s disk quota.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies a user's disk 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="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><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td 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> <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 account&#39;s new quota.</p>
<ul>
<li>A positive integer that represents the maximum amount of disk space, in megabytes (MB).</li>
<li>0 or unlimited grants the account unlimited disk space.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's new quota.</p>
<ul>
<li>A positive integer that represents the maximum amount of disk space, in megabytes (MB).</li>
<li>0 or unlimited grants the account unlimited disk space.</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=user</span></div><div><div html="<p>The cPanel account username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="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">/editquota</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/editquota</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99m91a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99m91a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99m91a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99m91a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99m91a:0" aria-labelledby="tab:R99m91a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
editquota <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">quota</span><span class="token operator">=</span><span class="token string">'500'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99m91a:1" aria-labelledby="tab:R99m91a: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:R9pm91a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pm91a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pm91a:0" aria-labelledby="tab:R9pm91a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"editquota"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Set quota for user."</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/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>Accounts / Domain Domain Information</p>
"><p>Accounts / Domain Domain Information</p>
</div></div></div><div id="tag/Domain-Information/operation/convert_addon_fetch_conversion_details" data-section-id="tag/Domain-Information/operation/convert_addon_fetch_conversion_details" class="sc-dntaoT ceciOs"><div data-section-id="operation/convert_addon_fetch_conversion_details" id="operation/convert_addon_fetch_conversion_details" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Information/operation/convert_addon_fetch_conversion_details" aria-label="tag/Domain-Information/operation/convert_addon_fetch_conversion_details"></a>Return additional domain conversion details<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the details of a conversion from an addon
domain to an account. Use WHM API 1&#39;s <code>convert_addon_domain_to_account</code>
to start a conversion.</p>
<p><strong>Important:</strong></p>
<p>When you disable the
<a href="https://go.cpanel.net/howtouseserverprofiles">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the details of a conversion from an addon
domain to an account. Use WHM API 1's <code>convert_addon_domain_to_account</code>
to start a conversion.</p>
<p><strong>Important:</strong></p>
<p>When you disable the
<a href="https://go.cpanel.net/howtouseserverprofiles">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="job_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">job_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">job_id=2</span></div><div><div html="<p>The conversion&#39;s job identification number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The conversion's job identification 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/convert_addon_fetch_conversion_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/convert_addon_fetch_conversion_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:Rii6b1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii6b1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii6b1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii6b1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii6b1a:0" aria-labelledby="tab:Rii6b1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
convert_addon_fetch_conversion_details <span class="token punctuation">\</span>
<span class="token assign-left variable">job_id</span><span class="token operator">=</span><span class="token string">'2'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii6b1a:1" aria-labelledby="tab:Rii6b1a: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:Rji6b1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji6b1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji6b1a:0" aria-labelledby="tab:Rji6b1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"cptestaddon175.tld"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"job_end_time"</span>: <span class="token number">1462216653</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"job_id"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"job_start_time"</span>: <span class="token number">1462465001</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"job_status"</span>: <span class="token string">"DONE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"source_acct"</span>: <span class="token string">"cptest"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"steps"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"end_time"</span>: <span class="token number">1462465001</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465001</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Saving email forwarder data"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"end_time"</span>: <span class="token number">1462465001</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465001</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Saving custom DNS records"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"end_time"</span>: <span class="token number">1462465001</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465001</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Saving installed SSL Certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"end_time"</span>: <span class="token number">1462465001</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465001</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Saving EasyApache 4 configuration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"end_time"</span>: <span class="token number">1462465009</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465001</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Removing Addon Domain"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"end_time"</span>: <span class="token number">1462465014</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465009</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Creating new cPanel account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"end_time"</span>: <span class="token number">1462465015</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465014</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Restoring custom DNS records"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"end_time"</span>: <span class="token number">1462465016</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465015</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Copying Custom VirtualHost Includes"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"end_time"</span>: <span class="token number">1462465016</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465016</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Copying document root content"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token string">"/usr/bin/gtar: ./shadow: Cannot open: Permission denied\\n/usr/bin/gtar: Exiting with failure status due to previous errors"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"end_time"</span>: <span class="token number">1462465016</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465016</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Setting the proper permissions on document root"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"end_time"</span>: <span class="token number">1462465017</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465016</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Copying email accounts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"end_time"</span>: <span class="token number">1462465017</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465017</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Restoring email forwarders"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"end_time"</span>: <span class="token number">1462465017</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465017</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Copying Autoresponders"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"end_time"</span>: <span class="token number">1462465017</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465017</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Copying webmail data"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"end_time"</span>: <span class="token number">1462465017</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465017</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Restoring installed SSL Certificate"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"end_time"</span>: <span class="token number">1462465017</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462465017</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"step_name"</span>: <span class="token string">"Restoring EasyApache 4 configuration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</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">"target_acct"</span>: <span class="token string">"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">"metadata"</span>: <button class="collapser" aria-label="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">"convert_addon_fetch_conversion_details"</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/Domain-Information/operation/convert_addon_fetch_domain_details" data-section-id="tag/Domain-Information/operation/convert_addon_fetch_domain_details" class="sc-dntaoT ceciOs"><div data-section-id="operation/convert_addon_fetch_domain_details" id="operation/convert_addon_fetch_domain_details" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Information/operation/convert_addon_fetch_domain_details" aria-label="tag/Domain-Information/operation/convert_addon_fetch_domain_details"></a>Return additional domain data<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves domain data for an addon domain.</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 retrieves domain data for an addon domain.</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="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 addon domain for which to retrieve details.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The addon domain for which to retrieve details.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/convert_addon_fetch_domain_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/convert_addon_fetch_domain_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:Riiab1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiab1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiab1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiab1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiab1a:0" aria-labelledby="tab:Riiab1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
convert_addon_fetch_domain_details <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:Riiab1a:1" aria-labelledby="tab:Riiab1a: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:Rjiab1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiab1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiab1a:0" aria-labelledby="tab:Rjiab1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"docroot"</span>: <span class="token string">"/home/exampleparent/public_html/example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_dedicated_ip"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_ssl_cert_installed"</span>: <span class="token number">0</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">"is_sni_supported"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"number_of_autoresponders"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"number_of_domain_forwarders"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"number_of_email_accounts"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"number_of_email_forwarders"</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">"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">"metadata"</span>: <button class="collapser" aria-label="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">"convert_addon_fetch_domain_details"</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/Domain-Information/operation/convert_addon_get_conversion_status" data-section-id="tag/Domain-Information/operation/convert_addon_get_conversion_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/convert_addon_get_conversion_status" id="operation/convert_addon_get_conversion_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Information/operation/convert_addon_get_conversion_status" aria-label="tag/Domain-Information/operation/convert_addon_get_conversion_status"></a>Return conversion status for additional domain<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the status of the convert addon domain to
account process for specified conversion jobs. For data about the conversion
status of all jobs, use the WHM API 1 <code>convert_addon_fetch_conversion_details</code>
function.</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 status of the convert addon domain to
account process for specified conversion jobs. For data about the conversion
status of all jobs, use the WHM API 1 <code>convert_addon_fetch_conversion_details</code>
function.</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="job_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">job_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> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">job_id=job_id-1=10&job_id-2=33&job_id-3=15</span> -<!-- --> <!-- -->Get the status for multiple conversion jobs.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">job_id=10</span> -<!-- --> <!-- -->Get status for a single conversion job.</li></ul><div><div html="<p>The conversion&#39;s job identification number.</p>
<p><strong>Note:</strong></p>
<p>To list entries for multiple conversion jobs, increment the parameter name. For example: <code>job_id-0</code>, <code>job_id-1</code>, and <code>job_id-2</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The conversion's job identification number.</p>
<p><strong>Note:</strong></p>
<p>To list entries for multiple conversion jobs, increment the parameter name. For example: <code>job_id-0</code>, <code>job_id-1</code>, and <code>job_id-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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><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>An object that contains details about the conversion job&#39;s status.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An object that contains details about the conversion job's status.</p>
</div></div></div></td></tr><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">/convert_addon_get_conversion_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/convert_addon_get_conversion_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:Riieb1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riieb1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riieb1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riieb1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riieb1a:0" aria-labelledby="tab:Riieb1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
convert_addon_get_conversion_status <span class="token punctuation">\</span>
<span class="token assign-left variable">job_id</span><span class="token operator">=</span><span class="token string">'10'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riieb1a:1" aria-labelledby="tab:Riieb1a: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:Rjieb1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjieb1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjieb1a:0" aria-labelledby="tab:Rjieb1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"job_end_time"</span>: <span class="token number">1462383658</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"job_id"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"job_status"</span>: <span class="token string">"DONE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"source_acct"</span>: <span class="token string">"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">"metadata"</span>: <button class="collapser" aria-label="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">"convert_addon_get_conversion_status"</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/Domain-Information/operation/convert_addon_list_addon_domains" data-section-id="tag/Domain-Information/operation/convert_addon_list_addon_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/convert_addon_list_addon_domains" id="operation/convert_addon_list_addon_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/convert_addon_list_addon_domains" aria-label="tag/Domain-Information/operation/convert_addon_list_addon_domains"></a>Return current user's additional domains<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a list of addon domains that belong to the current user.</p>
<p><strong>Important:</strong>
When you disable the <a href="https://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 returns a list of addon domains that belong to the current user.</p>
<p><strong>Important:</strong>
When you disable the <a href="https://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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/convert_addon_list_addon_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/convert_addon_list_addon_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:Riiib1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiib1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiib1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiib1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiib1a:0" aria-labelledby="tab:Riiib1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
convert_addon_list_addon_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiib1a:1" aria-labelledby="tab:Riiib1a: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:Rjiib1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiib1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiib1a:0" aria-labelledby="tab:Rjiib1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"docroot"</span>: <span class="token string">"/home/exampleparent/public_html/example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain_type"</span>: <span class="token string">"addon"</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">"owner"</span>: <span class="token string">"root"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subdomain"</span>: <span class="token string">"example.exampleparent.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">"metadata"</span>: <button class="collapser" aria-label="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">"convert_addon_list_addon_domains"</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/Domain-Information/operation/convert_addon_list_conversions" data-section-id="tag/Domain-Information/operation/convert_addon_list_conversions" class="sc-dntaoT ceciOs"><div data-section-id="operation/convert_addon_list_conversions" id="operation/convert_addon_list_conversions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Information/operation/convert_addon_list_conversions" aria-label="tag/Domain-Information/operation/convert_addon_list_conversions"></a>Return additional domains conversion queue<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a list of addon domains undergoing conversion
into cPanel accounts.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://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 returns a list of addon domains undergoing conversion
into cPanel accounts.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/convert_addon_list_conversions</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/convert_addon_list_conversions</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riimb1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riimb1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riimb1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riimb1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riimb1a:0" aria-labelledby="tab:Riimb1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
convert_addon_list_conversions
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riimb1a:1" aria-labelledby="tab:Riimb1a: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:Rjimb1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjimb1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjimb1a:0" aria-labelledby="tab:Rjimb1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"conversions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"end_time"</span>: <span class="token number">1462216653</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"job_id"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"source_acct"</span>: <span class="token string">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1462216639</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target_acct"</span>: <span class="token string">"example2"</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">"metadata"</span>: <button class="collapser" aria-label="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">"convert_addon_list_conversions"</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/Domain-Information/operation/convert_addon_initiate_conversion" data-section-id="tag/Domain-Information/operation/convert_addon_initiate_conversion" class="sc-dntaoT ceciOs"><div data-section-id="operation/convert_addon_initiate_conversion" id="operation/convert_addon_initiate_conversion" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Information/operation/convert_addon_initiate_conversion" aria-label="tag/Domain-Information/operation/convert_addon_initiate_conversion"></a>Start additional domain conversion<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function initiates the conversion process for an addon domain
into a cPanel account.</p>
<p><strong>Note:</strong></p>
<p>For information about the data that the system migrates when you convert an
addon domain, read our
<a href="https://go.cpanel.net/AddonConversionList">Addon Domain Conversion List documentation</a>.</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 initiates the conversion process for an addon domain
into a cPanel account.</p>
<p><strong>Note:</strong></p>
<p>For information about the data that the system migrates when you convert an
addon domain, read our
<a href="https://go.cpanel.net/AddonConversionList">Addon Domain Conversion List documentation</a>.</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=""><td kind="field" title="copymysqldb-*" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">copymysqldb-*</span></td><td class="sc-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">copymysqldb-*=copymysqldb-olddatabase1=newdatabase1 copymysqldb-olddatabase2=newdatabase2</span> -<!-- --> <!-- -->Copy multiple databases.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">copymysqldb-*=newdatabase</span> -<!-- --> <!-- -->Copy a single database.</li></ul><div><div html="<p>Copy a MySQL® database from the source account to the new account with a new
database name.</p>
<p>This parameter&#39;s format consists of <code>copymysqldb</code>, a hyphen, and the name of
the existing database. For example, <code>copymysqldb-olddatabase</code>.</p>
<p>If you do <strong>not</strong> specify this parameter, the system does <strong>not</strong> copy any MySQL
databases to the new account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Copy a MySQL® database from the source account to the new account with a new
database name.</p>
<p>This parameter's format consists of <code>copymysqldb</code>, a hyphen, and the name of
the existing database. For example, <code>copymysqldb-olddatabase</code>.</p>
<p>If you do <strong>not</strong> specify this parameter, the system does <strong>not</strong> copy any MySQL
databases to the new account.</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 addon domain to convert into an account&#39;s main domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The addon domain to convert into an account's main domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="movemysqldb" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">movemysqldb</span></td><td class="sc-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">movemysqldb=movemysqldb-1=exampledb1 movemysqldb-2=exampledb2 movemysqluser-3=exampledb3</span> -<!-- --> <!-- -->Move multiple databases.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">movemysqldb=exampledb</span> -<!-- --> <!-- -->Move a single database.</li></ul><div><div html="<p>Move the specified MySQL database from the source account to the new account.</p>
<p>If you do <strong>not</strong> specify this parameter, the system does <strong>not</strong> move any MySQL
databases to the new account.</p>
<p><strong>Note:</strong></p>
<p>To move multiple databases, increment the parameter name. For example, <code>movemysqldb-1</code>,
<code>movemysqldb-2</code>, and <code>movemysqldb-3</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Move the specified MySQL database from the source account to the new account.</p>
<p>If you do <strong>not</strong> specify this parameter, the system does <strong>not</strong> move any MySQL
databases to the new account.</p>
<p><strong>Note:</strong></p>
<p>To move multiple databases, increment the parameter name. For example, <code>movemysqldb-1</code>,
<code>movemysqldb-2</code>, and <code>movemysqldb-3</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="movemysqluser" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">movemysqluser</span></td><td class="sc-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">movemysqluser=movemysqluser-1=dbuser1 movemysqluser-2=dbuser2 movemysqluser-3=dbuser3</span> -<!-- --> <!-- -->Move multiple database users.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">movemysqluser=dbuser1</span> -<!-- --> <!-- -->Move a single database user.</li></ul><div><div html="<p>Move the specified MySQL database user from the source account into the new
MySQL database account.</p>
<p>If you do <strong>not</strong> specify this parameter, the system does <strong>not</strong> move any MySQL
database users to the new account.</p>
<p><strong>Note:</strong></p>
<p>To move multiple database users, increment the parameter name. For example, <code>movemysqluser-1</code>,
<code>movemysqluser-2</code>, and <code>movemysqluser-3</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Move the specified MySQL database user from the source account into the new
MySQL database account.</p>
<p>If you do <strong>not</strong> specify this parameter, the system does <strong>not</strong> move any MySQL
database users to the new account.</p>
<p><strong>Note:</strong></p>
<p>To move multiple database users, increment the parameter name. For example, <code>movemysqluser-1</code>,
<code>movemysqluser-2</code>, and <code>movemysqluser-3</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="pkgname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">pkgname</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"default"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">pkgname=mycustompkg</span></div><div><div html="<p>The hosting package that you want to assign to the new account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting package that you want to assign to the new account.</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=username</span></div><div><div html="<p>The username for a specified account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username for a specified 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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/convert_addon_initiate_conversion</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/convert_addon_initiate_conversion</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiqb1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiqb1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiqb1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiqb1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiqb1a:0" aria-labelledby="tab:Riiqb1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
convert_addon_initiate_conversion <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">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:Riiqb1a:1" aria-labelledby="tab:Riiqb1a: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:Rjiqb1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiqb1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiqb1a:0" aria-labelledby="tab:Rjiqb1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"convert_addon_initiate_conversion"</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/Domain-Information/operation/domainuserdata" data-section-id="tag/Domain-Information/operation/domainuserdata" class="sc-dntaoT ceciOs"><div data-section-id="operation/domainuserdata" id="operation/domainuserdata" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Information/operation/domainuserdata" aria-label="tag/Domain-Information/operation/domainuserdata"></a>Return domain user information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves domain data.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves domain 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><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 account&#39;s main domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's main 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/domainuserdata</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/domainuserdata</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiub1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiub1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiub1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiub1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiub1a:0" aria-labelledby="tab:Riiub1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
domainuserdata <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:Riiub1a:1" aria-labelledby="tab:Riiub1a: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:Rjiub1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiub1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiub1a:0" aria-labelledby="tab:Rjiub1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"userdata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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></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/username/public_html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"reseller_username"</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/username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</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">"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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"owner@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 seconddomain.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">"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">"Off"</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"domainuserdata"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Obtained userdata."</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/Domain-Information/operation/get_domain_info" data-section-id="tag/Domain-Information/operation/get_domain_info" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_domain_info" id="operation/get_domain_info" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Information/operation/get_domain_info" aria-label="tag/Domain-Information/operation/get_domain_info"></a>Return all domains information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns information about each domain on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns information about each domain on the 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_domain_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_domain_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:Rij2b1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij2b1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij2b1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij2b1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij2b1a:0" aria-labelledby="tab:Rij2b1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_domain_info
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij2b1a:1" aria-labelledby="tab:Rij2b1a: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:Rjj2b1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj2b1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj2b1a:0" aria-labelledby="tab:Rjj2b1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"docroot"</span>: <span class="token string">"/home/user1/public_html/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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain_type"</span>: <span class="token string">"addon"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ipv4"</span>: <span class="token string">"192.0.2.255"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ipv4_ssl"</span>: <span class="token string">"192.0.2.255"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ipv6"</span>: <span class="token string">"2001:DB8:g1m:0N3y::1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ipv6_is_dedicated"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modsecurity_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_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">"php_version"</span>: <span class="token string">"ea-php54"</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">"port_ssl"</span>: <span class="token number">443</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">"user_owner"</span>: <span class="token string">"user1"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_domain_info"</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/Domain-Information/operation/getdomainowner" data-section-id="tag/Domain-Information/operation/getdomainowner" class="sc-dntaoT ceciOs"><div data-section-id="operation/getdomainowner" id="operation/getdomainowner" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Information/operation/getdomainowner" aria-label="tag/Domain-Information/operation/getdomainowner"></a>Return domain owner<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the owner of a domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the owner of 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>A domain on the system that is owned by the user calling this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A domain on the system that is owned by the user calling this 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/getdomainowner</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/getdomainowner</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij6b1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij6b1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij6b1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij6b1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij6b1a:0" aria-labelledby="tab:Rij6b1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
getdomainowner <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:Rij6b1a:1" aria-labelledby="tab:Rij6b1a: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:Rjj6b1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj6b1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj6b1a:0" aria-labelledby="tab:Rjj6b1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"metadata"</span>: <button class="collapser" aria-label="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">"getdomainowner"</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/Passwords" data-section-id="tag/Passwords" 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/Passwords" aria-label="tag/Passwords"></a>Passwords</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Accounts / Passwords</p>
"><p>Accounts / Passwords</p>
</div></div></div><div id="tag/Passwords/operation/getminimumpasswordstrengths" data-section-id="tag/Passwords/operation/getminimumpasswordstrengths" class="sc-dntaoT ceciOs"><div data-section-id="operation/getminimumpasswordstrengths" id="operation/getminimumpasswordstrengths" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Passwords/operation/getminimumpasswordstrengths" aria-label="tag/Passwords/operation/getminimumpasswordstrengths"></a>Return minimum password strength<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the minimum password strength for cPanel &amp; WHM accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the minimum password strength for cPanel & WHM 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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"default"</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">"list"</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">"postgres"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"sshkey"</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">name=default</span></div><div><div html="<p>The service for which to display the minimum password value.
If you do not use this parameter, this function returns the minimum password
setting for all values.</p>
<ul>
<li><code>default</code> - All services</li>
<li><code>cpaddons</code> - cPAddons</li>
<li><code>createacct</code> - New cPanel accounts</li>
<li><code>list</code> - Mailing lists</li>
<li><code>mysql</code> - MySQL® database users</li>
<li><code>passwd</code> - WHM user or system accounts</li>
<li><code>postgres</code> - PostgreSQL database users</li>
<li><code>sshkey</code> - SSH keys</li>
<li><code>virtual</code> - Mail, FTP, Web Disk, and WebDAV accounts</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service for which to display the minimum password value.
If you do not use this parameter, this function returns the minimum password
setting for all values.</p>
<ul>
<li><code>default</code> - All services</li>
<li><code>cpaddons</code> - cPAddons</li>
<li><code>createacct</code> - New cPanel accounts</li>
<li><code>list</code> - Mailing lists</li>
<li><code>mysql</code> - MySQL® database users</li>
<li><code>passwd</code> - WHM user or system accounts</li>
<li><code>postgres</code> - PostgreSQL database users</li>
<li><code>sshkey</code> - SSH keys</li>
<li><code>virtual</code> - Mail, FTP, Web Disk, and WebDAV accounts</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/getminimumpasswordstrengths</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/getminimumpasswordstrengths</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R996d1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R996d1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R996d1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R996d1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R996d1a:0" aria-labelledby="tab:R996d1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
getminimumpasswordstrengths
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996d1a:1" aria-labelledby="tab:R996d1a: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:R9p6d1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p6d1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p6d1a:0" aria-labelledby="tab:R9p6d1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cpaddons"</span>: <span class="token number">50</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createacct"</span>: <span class="token number">50</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default"</span>: <span class="token number">50</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"list"</span>: <span class="token number">50</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql"</span>: <span class="token number">50</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd"</span>: <span class="token number">50</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"postgres"</span>: <span class="token number">50</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sshkey"</span>: <span class="token number">50</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"virtual"</span>: <span class="token number">50</span></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">"command"</span>: <span class="token string">"getminimumpasswordstrengths"</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/Passwords/operation/setminimumpasswordstrengths" data-section-id="tag/Passwords/operation/setminimumpasswordstrengths" class="sc-dntaoT ceciOs"><div data-section-id="operation/setminimumpasswordstrengths" id="operation/setminimumpasswordstrengths" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Passwords/operation/setminimumpasswordstrengths" aria-label="tag/Passwords/operation/setminimumpasswordstrengths"></a>Update minimum password strength<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the minimum password strength for cPanel &amp; WHM
accounts.</p>
<p><strong>Note</strong></p>
<p>If you do <strong>not</strong> specify a value for a parameter, the system will retain the existing setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the minimum password strength for cPanel & WHM
accounts.</p>
<p><strong>Note</strong></p>
<p>If you do <strong>not</strong> specify a value for a parameter, the system will retain the existing 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><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="cpaddons" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpaddons</span></td><td class="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 .. 100 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cpaddons=50</span></div><div><div html="<p>The minimum password strength for cPAddons.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The minimum password strength for cPAddons.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="createacct" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">createacct</span></td><td class="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 .. 100 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">createacct=50</span></div><div><div html="<p>The minimum password strength for new cPanel accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The minimum password strength for new cPanel accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="default" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> <!-- -->[ 1 .. 100 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">default=50</span></div><div><div html="<p>The minimum password strength for all services.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The minimum password strength for all services.</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></td><td class="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 .. 100 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">list=50</span></div><div><div html="<p>The minimum password strength for mailing lists.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The minimum password strength for mailing lists.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="mysql" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mysql</span></td><td class="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 .. 100 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mysql=50</span></div><div><div html="<p>The minimum password strength for MySQL® database users.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The minimum password strength for MySQL® database users.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="passwd" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">passwd</span></td><td class="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 .. 100 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">passwd=50</span></div><div><div html="<p>The minimum password strength for WHM user or system accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The minimum password strength for WHM user or system accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="postgres" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">postgres</span></td><td class="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 .. 100 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">postgres=50</span></div><div><div html="<p>The minimum password strength for PostgreSQL® database users.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The minimum password strength for PostgreSQL® database users.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="sshkey" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">sshkey</span></td><td class="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 .. 100 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">sshkey=50</span></div><div><div html="<p>The minimum password strength for SSH keys.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The minimum password strength for SSH keys.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="virtual" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">virtual</span></td><td class="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 .. 100 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">virtual=50</span></div><div><div html="<p>The minimum password strength for mail, FTP, Web Disk, and WebDAV accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The minimum password strength for mail, FTP, Web Disk, and WebDAV accounts.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/setminimumpasswordstrengths</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/setminimumpasswordstrengths</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99ad1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ad1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ad1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ad1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ad1a:0" aria-labelledby="tab:R99ad1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
setminimumpasswordstrengths
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ad1a:1" aria-labelledby="tab:R99ad1a: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:R9pad1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pad1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pad1a:0" aria-labelledby="tab:R9pad1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"setminimumpasswordstrengths"</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/Passwords/operation/get_password_strength" data-section-id="tag/Passwords/operation/get_password_strength" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_password_strength" id="operation/get_password_strength" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Passwords/operation/get_password_strength" aria-label="tag/Passwords/operation/get_password_strength"></a>Return password strength<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function measures the strength of a password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function measures the strength of a 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="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 password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_password_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_password_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:R99ed1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ed1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ed1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ed1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ed1a:0" aria-labelledby="tab:R99ed1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_password_strength <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:R99ed1a:1" aria-labelledby="tab:R99ed1a: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:R9ped1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ped1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ped1a:0" aria-labelledby="tab:R9ped1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">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">"metadata"</span>: <button class="collapser" aria-label="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">"get_password_strength"</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/Passwords/operation/forcepasswordchange" data-section-id="tag/Passwords/operation/forcepasswordchange" class="sc-dntaoT ceciOs"><div data-section-id="operation/forcepasswordchange" id="operation/forcepasswordchange" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Passwords/operation/forcepasswordchange" aria-label="tag/Passwords/operation/forcepasswordchange"></a>Enable forced password update<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function forces a user to change the account password after the next login attempt.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function forces a user to change the account password after the next login attempt.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="stop_on_failure" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">stop_on_failure</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">stop_on_failure=1</span></div><div><div html="<p>Whether to halt the function if it experiences an error.</p>
<ul>
<li><code>1</code> - Halt on error.</li>
<li><code>0</code> - Continue on error.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to halt the function if it experiences an error.</p>
<ul>
<li><code>1</code> - Halt on error.</li>
<li><code>0</code> - Continue on error.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="users_json" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">users_json</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->json<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">users_json={"user1":1,"user2":1,"user3":1}</span></div><div><div html="<p>The list of users. The system will force each user that you specify to change their account&#39;s password the next time that they log in.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The list of users. The system will force each user that you specify to change their account's password the next time that 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/forcepasswordchange</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/forcepasswordchange</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99id1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99id1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99id1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99id1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99id1a:0" aria-labelledby="tab:R99id1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
forcepasswordchange <span class="token punctuation">\</span>
<span class="token assign-left variable">users_json</span><span class="token operator">=</span><span class="token string">'{"user1":1,"user2":1,"user3":1}'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99id1a:1" aria-labelledby="tab:R99id1a: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:R9pid1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pid1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pid1a:0" aria-labelledby="tab:R9pid1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"updated"</span>: <button class="collapser" aria-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"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"forcepasswordchange"</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/Passwords/operation/passwd" data-section-id="tag/Passwords/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/Passwords/operation/passwd" aria-label="tag/Passwords/operation/passwd"></a>Update cPanel account password<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function modifies a cPanel or reseller account&#39;s password.</p>
<p><strong>Note</strong></p>
<ul>
<li>When modifying the root password, this will only update the password for the root system user, but not for the root MySQL user.</li>
<li>To update the MySQL root user&#39;s password, use set_local_mysql_root_password.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies a cPanel or reseller account's password.</p>
<p><strong>Note</strong></p>
<ul>
<li>When modifying the root password, this will only update the password for the root system user, but not for the root MySQL user.</li>
<li>To update the MySQL root user's password, use set_local_mysql_root_password.</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="db_pass_update" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">db_pass_update</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">db_pass_update=0</span></div><div><div html="<p>Whether to also change the account&#39;s MySQL® password.</p>
<ul>
<li><code>1</code> — Also update the account&#39;s MySQL password to match the <code>password</code> value.</li>
<li><code>0</code> — Do <strong>not</strong> update.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to also change the account's MySQL® password.</p>
<ul>
<li><code>1</code> — Also update the account's MySQL password to match the <code>password</code> value.</li>
<li><code>0</code> — Do <strong>not</strong> update.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="enabledigest or digestauth" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enabledigest or digestauth</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">enabledigest or digestauth=1</span></div><div><div html="<p>Whether to enable Digest Authentication for the account. If you
do <strong>not</strong> specify a value, the account retains its current Digest
Authentication setting.</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 Digest Authentication for the account. If you
do <strong>not</strong> specify a value, the account retains its current Digest
Authentication setting.</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="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 account&#39;s new password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 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=username</span></div><div><div html="<p>The account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99md1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99md1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99md1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99md1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99md1a:0" aria-labelledby="tab:R99md1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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">'username'</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:R99md1a:1" aria-labelledby="tab:R99md1a: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:R9pmd1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pmd1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pmd1a:0" aria-labelledby="tab:R9pmd1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"app"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"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">"metadata"</span>: <button class="collapser" aria-label="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">"passwd"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Password changed for user “username”."</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/Styles" data-section-id="tag/Styles" 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/Styles" aria-label="tag/Styles"></a>Styles</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Server Administration / Account Management</p>
"><p>Server Administration / Account Management</p>
</div></div></div><div id="tag/Styles/operation/get_users_links" data-section-id="tag/Styles/operation/get_users_links" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_users_links" id="operation/get_users_links" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Styles/operation/get_users_links" aria-label="tag/Styles/operation/get_users_links"></a>Return cPanel account theme's app keys and URLs<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a list of
<a href="https://go.cpanel.net/jupiter-appkeys">application keys</a>
(appkeys) and the URLs that correspond to applications for the cPanel user&#39;s theme.
Use the appkey values for the <code>app</code> parameter&#39;s value in the WHM API 1 <code>create_user_session</code>
function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of
<a href="https://go.cpanel.net/jupiter-appkeys">application keys</a>
(appkeys) and the URLs that correspond to applications for the cPanel user's theme.
Use the appkey values for the <code>app</code> parameter's value in the WHM API 1 <code>create_user_session</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="service" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">service</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"cpaneld"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpaneld"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"webmail"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service=cpaneld</span></div><div><div html="<p>The interface for which to filter results:</p>
<ul>
<li><code>cpanel</code> — cPanel</li>
<li><code>webmail</code> — Webmail</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The interface for which to filter results:</p>
<ul>
<li><code>cpanel</code> — cPanel</li>
<li><code>webmail</code> — Webmail</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=user</span></div><div><div html="<p>The requested user&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The requested user'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><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>A list of appkeys and their corresponding file locations.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of appkeys and their corresponding file locations.</p>
</div></div></div></td></tr><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">/get_users_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_users_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:R2aef1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aef1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aef1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aef1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aef1a:0" aria-labelledby="tab:R2aef1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_users_links <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:R2aef1a:1" aria-labelledby="tab:R2aef1a: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:R2eef1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eef1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eef1a:0" aria-labelledby="tab:R2eef1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"Backups_Home"</span>: <span class="token string">"frontend/jupiter/backup/index.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Calendar_Configure"</span>: <span class="token string">"frontend/jupiter/mail/calendars_and_contacts/index.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ContactInfo_Change"</span>: <span class="token string">"frontend/jupiter/contact/index.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Cron_Home"</span>: <span class="token string">"frontend/jupiter/cron/index.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Database_MySQL"</span>: <span class="token string">"frontend/jupiter/sql/index.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Database_phpMyAdmin"</span>: <span class="token string">"frontend/jupiter/sql/PhpMyAdmin.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_AccountLevelFiltering"</span>: <span class="token string">"frontend/jupiter/mail/filters/userfilters.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_Accounts"</span>: <span class="token string">"frontend/jupiter/mail/pops/index.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_Archive"</span>: <span class="token string">"frontend/jupiter/mail/archive.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_Authentication"</span>: <span class="token string">"frontend/jupiter/mail/auth.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_AutoResponders"</span>: <span class="token string">"frontend/jupiter/mail/autores.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_BoxTrapper"</span>: <span class="token string">"frontend/jupiter/mail/boxtrapper.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_DefaultAddress"</span>: <span class="token string">"frontend/jupiter/mail/def.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_DeliveryReport"</span>: <span class="token string">"frontend/jupiter/mail/def.html"</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">"frontend/jupiter/mail/manage_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">"frontend/jupiter/mail/fwds.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_GreyListing"</span>: <span class="token string">"frontend/jupiter/mail/greylisting/index.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_MailingLists"</span>: <span class="token string">"frontend/jupiter/mail/lists.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_Routing"</span>: <span class="token string">"frontend/jupiter/mail/email_routing.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_SpamFilter"</span>: <span class="token string">"frontend/jupiter/mail/spam/spam.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_UserLevelFiltering"</span>: <span class="token string">"frontend/jupiter/mail/filters/managefilters.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FileManager_Home"</span>: <span class="token string">"frontend/jupiter/filemanager/index.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Locale_Change"</span>: <span class="token string">"frontend/jupiter/setlang/index.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Password_Change"</span>: <span class="token string">"frontend/jupiter/passwd/index.html"</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">"frontend/jupiter/ssl/index.html"</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">"frontend/jupiter/security/tls_status/"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"SSL_TLS_Wizard"</span>: <span class="token string">"frontend/jupiter/security/tls_wizard/"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Site_Software"</span>: <span class="token string">"frontend/jupiter/addoncgi/cpaddons.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Solr_Disk_Usage"</span>: <span class="token string">"frontend/jupiter/mail/search_index/"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Stats_AWStats"</span>: <span class="token string">"frontend/jupiter/stats/awstats_landing.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">"metadata"</span>: <button class="collapser" aria-label="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">"get_users_links"</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/Suspensions" data-section-id="tag/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/Suspensions" aria-label="tag/Suspensions"></a>Suspensions</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Accounts / Suspensions</p>
"><p>Accounts / Suspensions</p>
</div></div></div><div id="tag/Suspensions/operation/suspendacct" data-section-id="tag/Suspensions/operation/suspendacct" class="sc-dntaoT ceciOs"><div data-section-id="operation/suspendacct" id="operation/suspendacct" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Suspensions/operation/suspendacct" aria-label="tag/Suspensions/operation/suspendacct"></a>Suspend cPanel account<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function suspends an account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function suspends 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="disallowun" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">disallowun</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">disallowun=1</span></div><div><div html="<p>Whether to allow only the <code>root</code> user to unsuspend the account.</p>
<ul>
<li><code>1</code> - <strong>Only</strong> the <code>root</code> user can unsuspend the account.</li>
<li><code>0</code> - The <code>root</code> user or the account&#39;s owner can unsuspend the account.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow only the <code>root</code> user to unsuspend the account.</p>
<ul>
<li><code>1</code> - <strong>Only</strong> the <code>root</code> user can unsuspend the account.</li>
<li><code>0</code> - The <code>root</code> user or the account's owner can unsuspend the account.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="leave-ftp-accts-enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">leave-ftp-accts-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">leave-ftp-accts-enabled=0</span></div><div><div html="<p>Whether to skip suspension of the account&#39;s FTP accounts.</p>
<ul>
<li><code>1</code> - Do <strong>not</strong> suspend the FTP accounts.</li>
<li><code>0</code> - Suspend the FTP accounts.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip suspension of the account's FTP accounts.</p>
<ul>
<li><code>1</code> - Do <strong>not</strong> suspend the FTP accounts.</li>
<li><code>0</code> - Suspend the FTP accounts.</li>
</ul>
</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"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Unknown"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">reason=Nonpayment</span></div><div><div html="<p>The reason for suspension.</p>
<p><strong>Important:</strong></p>
<p> We strongly recommend that you provide a reason for suspension whenever you suspend an account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reason for suspension.</p>
<p><strong>Important:</strong></p>
<p> We strongly recommend that you provide a reason for suspension whenever you suspend an 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=username</span></div><div><div html="<p>The account to suspend.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account to suspend.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/suspendacct</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/suspendacct</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R996h1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R996h1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R996h1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R996h1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R996h1a:0" aria-labelledby="tab:R996h1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
suspendacct <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R996h1a:1" aria-labelledby="tab:R996h1a: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:R9p6h1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p6h1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p6h1a:0" aria-labelledby="tab:R9p6h1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"suspendacct"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"raw"</span>: <span class="token string">"Changing Shell to /bin/false...Changing shell for username. Warning: \"/bin/false\" is not listed in /etc/shells. Shell changed. Done Locking Password...Locking password for user username. passwd: Success Done Suspending mysql users Using Universal Quota Support (quota=0) Suspending websites... Using Universal Quota Support (quota=0) Suspending FTP accounts... Updating FTP passwords for username FTP password files updated. FTP vhost passwords synced username's account has been suspended\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">"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/Suspensions/operation/unsuspendacct" data-section-id="tag/Suspensions/operation/unsuspendacct" class="sc-dntaoT ceciOs"><div data-section-id="operation/unsuspendacct" id="operation/unsuspendacct" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Suspensions/operation/unsuspendacct" aria-label="tag/Suspensions/operation/unsuspendacct"></a>Unsuspend cPanel account<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function unsuspends an account.</p>
<p><strong>Note:</strong></p>
<p><strong>Only</strong> the <code>root</code> account and <code>root</code>-enabled resellers can unsuspend a locked account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function unsuspends an account.</p>
<p><strong>Note:</strong></p>
<p><strong>Only</strong> the <code>root</code> account and <code>root</code>-enabled resellers can unsuspend a locked 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="retain-service-proxies" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">retain-service-proxies</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">retain-service-proxies=0</span></div><div><div html="<p>Whether to retain any <a href="https://go.cpanel.net/serviceproxyglossary">service proxies</a> on an account.</p>
<ul>
<li><code>1</code> — Retain service proxies.</li>
<li><code>0</code> — Do <strong>not</strong> retain service proxies.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to retain any <a href="https://go.cpanel.net/serviceproxyglossary">service proxies</a> on an account.</p>
<ul>
<li><code>1</code> — Retain service proxies.</li>
<li><code>0</code> — Do <strong>not</strong> retain service proxies.</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=username</span></div><div><div html="<p>The account to unsuspend.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account to unsuspend.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/unsuspendacct</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/unsuspendacct</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99ah1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ah1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ah1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ah1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ah1a:0" aria-labelledby="tab:R99ah1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
unsuspendacct <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R99ah1a:1" aria-labelledby="tab:R99ah1a: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:R9pah1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pah1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pah1a:0" aria-labelledby="tab:R9pah1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"unsuspendacct"</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/Suspensions/operation/listlockedaccounts" data-section-id="tag/Suspensions/operation/listlockedaccounts" class="sc-dntaoT ceciOs"><div data-section-id="operation/listlockedaccounts" id="operation/listlockedaccounts" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Suspensions/operation/listlockedaccounts" aria-label="tag/Suspensions/operation/listlockedaccounts"></a>Return suspended cPanel accounts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists locked accounts on the server. <strong>Only</strong> WHM users with
<code>root</code>-level privileges can unsuspend locked accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists locked accounts on the server. <strong>Only</strong> WHM users with
<code>root</code>-level privileges can unsuspend locked 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/listlockedaccounts</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/listlockedaccounts</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99eh1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99eh1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99eh1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99eh1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99eh1a:0" aria-labelledby="tab:R99eh1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
listlockedaccounts
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99eh1a:1" aria-labelledby="tab:R99eh1a: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:R9peh1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9peh1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9peh1a:0" aria-labelledby="tab:R9peh1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"account1"</span>,</div></li><li><div class="hoverable "><span class="token string">"account2"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"listlockedaccounts"</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/Suspensions/operation/listsuspended" data-section-id="tag/Suspensions/operation/listsuspended" class="sc-dntaoT ceciOs"><div data-section-id="operation/listsuspended" id="operation/listsuspended" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Suspensions/operation/listsuspended" aria-label="tag/Suspensions/operation/listsuspended"></a>Return suspended cPanel accounts and information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists suspended accounts on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists suspended accounts on the 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/listsuspended</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/listsuspended</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99ih1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ih1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ih1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ih1a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ih1a:0" aria-labelledby="tab:R99ih1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
listsuspended
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ih1a:1" aria-labelledby="tab:R99ih1a: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:R9pih1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pih1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pih1a:0" aria-labelledby="tab:R9pih1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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_locked"</span>: <span class="token number">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">"reason"</span>: <span class="token string">"Suspended for nonpayment."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"time"</span>: <span class="token string">"Thu Nov 18 10:34:34 2014"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"unixtime"</span>: <span class="token number">1416306874</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></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">"command"</span>: <span class="token string">"listsuspended"</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/API-Execution" data-section-id="tag/API-Execution" 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-Execution" aria-label="tag/API-Execution"></a>API Execution</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>API Development Tools / API Execution</p>
"><p>API Development Tools / API Execution</p>
</div></div></div><div id="tag/API-Execution/operation/cors_proxy_get" data-section-id="tag/API-Execution/operation/cors_proxy_get" class="sc-dntaoT ceciOs"><div data-section-id="operation/cors_proxy_get" id="operation/cors_proxy_get" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/API-Execution/operation/cors_proxy_get" aria-label="tag/API-Execution/operation/cors_proxy_get"></a>Enable CORS HTTP requests<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function allows your system to perform Cross-Origin Resource Sharing (CORS) HTTP requests.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function allows your system to perform Cross-Origin Resource Sharing (CORS) HTTP requests.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><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://www.example.com</span></div><div><div html="<p>The website that you wish to access.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The website that you wish to access.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/cors_proxy_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/cors_proxy_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:R4kj31q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj31q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj31q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj31q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj31q:0" aria-labelledby="tab:R4kj31q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
cors_proxy_get <span class="token punctuation">\</span>
<span class="token assign-left variable">url</span><span class="token operator">=</span><span class="token string">'http://www.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj31q:1" aria-labelledby="tab:R4kj31q: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:R4sj31q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj31q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj31q:0" aria-labelledby="tab:R4sj31q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"_cp_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">"headers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"age"</span>: <span class="token string">"425879"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cache-control"</span>: <span class="token string">"max-age=604800"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content-length"</span>: <span class="token string">"1256"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content-type"</span>: <span class="token string">"text/html; charset=UTF-8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token string">"Thu, 05 Mar 2020 23:42:25 GMT"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"etag"</span>: <span class="token string">"\"3147526947+ident\""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires"</span>: <span class="token string">"Thu, 12 Mar 2020 23:42:25 GMT"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last-modified"</span>: <span class="token string">"Thu, 17 Oct 2019 07:18:26 GMT"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server"</span>: <span class="token string">"ECS (dab/4BA8)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vary"</span>: <span class="token string">"Accept-Encoding"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x-cache"</span>: <span class="token string">"HIT"</span></div></li></ul><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">"OK"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"200"</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">"url"</span>: <span class="token string">"</span><a href="http://www.example.com">http://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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content"</span>: <span class="token string">"<!doctype html>\\n<html>\\n<head>\\n <title>Example Domain</title>\\n\\n <meta charset=\\\"utf-8\\\" />\\n <meta http-equiv=\\\"Content-type\\\" content=\\\"text/html; charset=utf-8\\\" />\\n <meta name=\\\"viewport\\\" content=\\\"width=device-width, initial-scale=1\\\" />\\n <style type=\\\"text/css\\\">\\n body {\\n background-color: #f0f0f2;\\n margin: 0;\\n padding: 0;\\n font-family: -apple-system, system-ui, BlinkMacSystemFont, \\\"Segoe UI\\\", \\\"Open Sans\\\", \\\"Helvetica Neue\\\", Helvetica, Arial, sans-serif;\\n\\n }\\n div {\\n width: 600px;\\n margin: 5em auto;\\n padding: 2em;\\n background-color: #fdfdff;\\n border-radius: 0.5em;\\n box-shadow: 2px 3px 7px 2px rgba(0,0,0,0.02);\\n }\\n a:link, a:visited {\\n color: #38488f;\\n text-decoration: none;\\n }\\n @media (max-width: 700px) {\\n div {\\n margin: 0 auto;\\n width: auto;\\n }\\n }\\n </style>\\n</head>\\n\\n<body>\\n<div>\\n <h1>Example Domain</h1>\\n <p>This domain is for use in illustrative examples in documents. You may use this\\n domain in literature without prior coordination or asking for permission.</p>\\n <p><a href=\\\"https://www.iana.org/domains/example\\\">More information...</a></p>\\n</div>\\n</body>\\n</html>\\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">"metadata"</span>: <button class="collapser" aria-label="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">"cors_proxy_get"</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/API-Execution/operation/uapi_cpanel" data-section-id="tag/API-Execution/operation/uapi_cpanel" class="sc-dntaoT ceciOs"><div data-section-id="operation/uapi_cpanel" id="operation/uapi_cpanel" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/API-Execution/operation/uapi_cpanel" aria-label="tag/API-Execution/operation/uapi_cpanel"></a>Run UAPI function through WHM API<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function calls a UAPI function through the WHM API. This function&#39;s output will match the UAPI function that it calls.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function calls a UAPI function through the WHM API. This function's output will match the UAPI function that it calls.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="cpanel.function" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpanel.function</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cpanel.function=get_stats</span></div><div><div html="<p>The UAPI function to call.</p>
<p><em><strong>Note:</strong></em></p>
<p>You must include the UAPI function&#39;s required parameters. You can also include its optional parameters.</p>
<p>For example, to call the UAPI <code>get_stats</code> function with its required display parameter and the bandwidthusage and diskusage values:</p>
<p><code>display=bandwidthusage|diskusage</code></p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The UAPI function to call.</p>
<p><em><strong>Note:</strong></em></p>
<p>You must include the UAPI function's required parameters. You can also include its optional parameters.</p>
<p>For example, to call the UAPI <code>get_stats</code> function with its required display parameter and the bandwidthusage and diskusage values:</p>
<p><code>display=bandwidthusage|diskusage</code></p>
</div></div></div></td></tr><tr class=""><td kind="field" title="cpanel.module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpanel.module</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cpanel.module=StatsBar</span></div><div><div html="<p>The UAPI function&#39;s cPanel module.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The UAPI function's cPanel module.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="cpanel.user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpanel.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">cpanel.user=username</span></div><div><div html="<p>The cPanel username to call with the UAPI function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel username to call with the UAPI 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/uapi_cpanel</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/uapi_cpanel</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl31q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl31q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl31q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl31q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl31q:0" aria-labelledby="tab:R4kl31q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
uapi_cpanel <span class="token punctuation">\</span>
<span class="token assign-left variable">cpanel.function</span><span class="token operator">=</span><span class="token string">'get_stats'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">cpanel.module</span><span class="token operator">=</span><span class="token string">'StatsBar'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">cpanel.user</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:R4kl31q:1" aria-labelledby="tab:R4kl31q: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:R4sl31q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl31q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl31q:0" aria-labelledby="tab:R4sl31q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"uapi"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_max"</span>: <span class="token string">"unlimited"</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"</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">"id"</span>: <span class="token string">"addondomains"</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">"Addon Domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max"</span>: <span class="token string">"unlimited"</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 allotment ([numf,_1]) of addon domains."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Park"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"addondomains"</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 [numf,_1] of [numf,_2] available addon [numerate,_2,domain,domains]."</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">"Addon Domains"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <span class="token string">"WebServer"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"zeroisunlimited"</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="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">"uapi_cpanel"</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/API-Execution/operation/batch" data-section-id="tag/API-Execution/operation/batch" class="sc-dntaoT ceciOs"><div data-section-id="operation/batch" id="operation/batch" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/API-Execution/operation/batch" aria-label="tag/API-Execution/operation/batch"></a>Run multiple WHM API 1 functions<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function combines calls for multiple WHM API 1 functions.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function combines calls for multiple WHM API 1 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=""><td kind="field" title="abort_on_error" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">abort_on_error</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">abort_on_error=0</span></div><div><div html="<p>Whether to stop processing remaining commands in the batch when a command returns an error.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> process remaining commands in the batch when an error occurs.</li>
<li><code>0</code> — When an error occurs, process the remaining commands in the batch.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to stop processing remaining commands in the batch when a command returns an error.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> process remaining commands in the batch when an error occurs.</li>
<li><code>0</code> — When an error occurs, process the remaining commands in the batch.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="command" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">command</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">command=version</span></div><div><div html="<p>The WHM API 1 function to call.</p>
<p><strong>Important:</strong></p>
<p>Specify a <code>command</code> parameter for each function.</p>
<p><strong>Note:</strong></p>
<p>Include the function&#39;s input parameters as a URI-encoded list after the function name.
For example, to call the <code>killdns</code> function with a <code>domain</code> parameter value of <code>example.com</code>
directly you would use:</p>
<p> <code>killdns?domain=example.com</code></p>
<p>To call this function using the <code>batch</code> function, URI-encode the command and pass it as part of the <code>batch</code> function:</p>
<p> <code>/json-api/batch?api.version=1&amp;command=killdns%3Fdomain%3Dexample.com</code></p>
<p>You can call the same function multiple times within a single batch API call. For example:</p>
<p> <code>/json-api/batch?api.version=1&amp;command=version&amp;command=version&amp;command=version</code></p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WHM API 1 function to call.</p>
<p><strong>Important:</strong></p>
<p>Specify a <code>command</code> parameter for each function.</p>
<p><strong>Note:</strong></p>
<p>Include the function's input parameters as a URI-encoded list after the function name.
For example, to call the <code>killdns</code> function with a <code>domain</code> parameter value of <code>example.com</code>
directly you would use:</p>
<p> <code>killdns?domain=example.com</code></p>
<p>To call this function using the <code>batch</code> function, URI-encode the command and pass it as part of the <code>batch</code> function:</p>
<p> <code>/json-api/batch?api.version=1&command=killdns%3Fdomain%3Dexample.com</code></p>
<p>You can call the same function multiple times within a single batch API call. For example:</p>
<p> <code>/json-api/batch?api.version=1&command=version&command=version&command=version</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/batch</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/batch</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn31q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn31q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn31q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn31q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn31q:0" aria-labelledby="tab:R4kn31q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
batch <span class="token punctuation">\</span>
<span class="token assign-left variable">command</span><span class="token operator">=</span><span class="token string">'version'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn31q:1" aria-labelledby="tab:R4kn31q: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:R4sn31q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn31q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn31q:0" aria-labelledby="tab:R4sn31q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"example-hosting.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">"command"</span>: <span class="token string">"gethostname"</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>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"11.88.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">"metadata"</span>: <button class="collapser" aria-label="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">"version"</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></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"batch"</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/API-Execution/operation/cpanel" data-section-id="tag/API-Execution/operation/cpanel" class="sc-dntaoT ceciOs"><div data-section-id="operation/cpanel" id="operation/cpanel" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/API-Execution/operation/cpanel" aria-label="tag/API-Execution/operation/cpanel"></a>Run cPanel API or UAPI function<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>You can call cPanel API and UAPI functions through the WHM API.</p>
<p>This method is useful, for example, when you develop plugins for WHM users, particularly resellers, but need to access cPanel functions. You can make these calls from within either the WHM or cPanel interfaces.</p>
<p><strong>Important:</strong></p>
<p>We recommend that you use the WHM API 1 <code>uapi_cpanel</code> function. The <code>uapi_cpanel</code> function is a more flexible way to call cPanel API functions from WHM. For example, you can use the <code>uapi_cpanel</code> function with the WHM API 1 <code>batch</code> function.</p>
<p>Before calling a cPanel API function via this method, read its documentation. The cPanel API function may require other parameters <strong>not</strong> listed in this document.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>You can call cPanel API and UAPI functions through the WHM API.</p>
<p>This method is useful, for example, when you develop plugins for WHM users, particularly resellers, but need to access cPanel functions. You can make these calls from within either the WHM or cPanel interfaces.</p>
<p><strong>Important:</strong></p>
<p>We recommend that you use the WHM API 1 <code>uapi_cpanel</code> function. The <code>uapi_cpanel</code> function is a more flexible way to call cPanel API functions from WHM. For example, you can use the <code>uapi_cpanel</code> function with the WHM API 1 <code>batch</code> function.</p>
<p>Before calling a cPanel API function via this method, read its documentation. The cPanel API function may require other parameters <strong>not</strong> listed in this document.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="cpanel_jsonapi_apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpanel_jsonapi_apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">2</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">cpanel_jsonapi_apiversion=3</span></div><div><div html="<p>The cPanel API version to use.</p>
<ul>
<li><code>1</code> — Use cPanel API 1.</li>
<li><code>2</code> — Use cPanel API 2.</li>
<li><code>3</code> — Use UAPI.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel API version to use.</p>
<ul>
<li><code>1</code> — Use cPanel API 1.</li>
<li><code>2</code> — Use cPanel API 2.</li>
<li><code>3</code> — Use UAPI.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="cpanel_jsonapi_func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpanel_jsonapi_func</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cpanel_jsonapi_func=listpopswithdisk</span></div><div><div html="<p>The UAPI function name.</p>
<p><strong>Important:</strong></p>
<p>Function names are <strong>case-sensitive</strong>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The UAPI function name.</p>
<p><strong>Important:</strong></p>
<p>Function names are <strong>case-sensitive</strong>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="cpanel_jsonapi_module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpanel_jsonapi_module</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cpanel_jsonapi_module=Email</span></div><div><div html="<p>The UAPI module name.</p>
<p><strong>Important:</strong></p>
<p>Module names are <strong>case-sensitive</strong>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The UAPI module name.</p>
<p><strong>Important:</strong></p>
<p>Module names are <strong>case-sensitive</strong>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="cpanel_jsonapi_user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpanel_jsonapi_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">cpanel_jsonapi_user=user</span></div><div><div html="<p>The cPanel username for the account through which to call the function.</p>
<p>Make <strong>certain</strong> that you specify the username in lowercase characters <strong>only</strong>. cPanel &amp; WHM automatically converts usernames to lowercase when you create a cPanel account. For this reason, if you supply a username that includes some or all capital letters, the call will fail.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel username for the account through which to call the function.</p>
<p>Make <strong>certain</strong> that you specify the username in lowercase characters <strong>only</strong>. cPanel & WHM automatically converts usernames to lowercase when you create a cPanel account. For this reason, if you supply a username that includes some or all capital letters, the call will fail.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="Variable Names and Values" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">Variable Names and Values</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The function&#39;s input parameters and their values. You can add any additional parameters supported by the underlying cPanel API function.</p>
<p>Example: <code>domain=example.com</code></p>
<p><strong>Note:</strong></p>
<ul>
<li>Separate multiple <code>parameter=value</code> pairs with the ampersand character (<code>&amp;</code>).</li>
<li>You <strong>must</strong> URI-encode these values.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The function's input parameters and their values. You can add any additional parameters supported by the underlying cPanel API function.</p>
<p>Example: <code>domain=example.com</code></p>
<p><strong>Note:</strong></p>
<ul>
<li>Separate multiple <code>parameter=value</code> pairs with the ampersand character (<code>&</code>).</li>
<li>You <strong>must</strong> URI-encode these values.</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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><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="<p>Information returned by the cPanel API function passed in <code>cpanel_jsonapi_module</code> and <code>cpanel_jsonapi_func</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Information returned by the cPanel API function passed in <code>cpanel_jsonapi_module</code> and <code>cpanel_jsonapi_func</code>.</p>
</div></div></div></td></tr><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">/cpanel</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/cpanel</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp31q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp31q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp31q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp31q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp31q:0" aria-labelledby="tab:R4kp31q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
cpanel <span class="token punctuation">\</span>
<span class="token assign-left variable">cpanel_jsonapi_user</span><span class="token operator">=</span><span class="token string">'user'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">cpanel_jsonapi_module</span><span class="token operator">=</span><span class="token string">'Email'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">cpanel_jsonapi_func</span><span class="token operator">=</span><span class="token string">'listpopswithdisk'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp31q:1" aria-labelledby="tab:R4kp31q: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:R4sp31q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp31q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp31q:0" aria-labelledby="tab:R4sp31q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"cpanel"</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/API-Execution/operation/execute_remote_whmapi1_with_password" data-section-id="tag/API-Execution/operation/execute_remote_whmapi1_with_password" class="sc-dntaoT ceciOs"><div data-section-id="operation/execute_remote_whmapi1_with_password" id="operation/execute_remote_whmapi1_with_password" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/API-Execution/operation/execute_remote_whmapi1_with_password" aria-label="tag/API-Execution/operation/execute_remote_whmapi1_with_password"></a>Run remote WHM API 1 function<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function executes WHM API 1 functions on a remote server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function executes WHM API 1 functions on a remote 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="function" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">function</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">function=passwd</span></div><div><div html="<p>The name of the function to call on the remote server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the function to call on the remote server.</p>
</div></div></div></td></tr><tr class=""><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=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="parameter_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">parameter_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">parameter_name=user</span></div><div><div html="<p>The name of the parameter for the function.</p>
<p><strong>Note:</strong></p>
<p> You must enter the same number of parameter_name and parameter_value parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the parameter for the function.</p>
<p><strong>Note:</strong></p>
<p> You must enter the same number of parameter_name and parameter_value parameters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="parameter_value" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">parameter_value</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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_value=username2</span></div><div><div html="<p>The value of the parameter for the function.</p>
<p><strong>Note:</strong></p>
<p> You must enter the same number of parameter_name and parameter_value parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The value of the parameter for the function.</p>
<p><strong>Note:</strong></p>
<p> You must enter the same number of parameter_name and parameter_value parameters.</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 to log in to the remote server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The password to log in to the remote server.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="tls_verification" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">tls_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">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">tls_verification=on</span></div><div><div html="<p>Whether to use TLS verification. This parameter defaults to On.</p>
<p><strong>Important:</strong></p>
<p> We strongly recommend that you use TLS verification. Only connect to a server if you can verify its identity.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use TLS verification. This parameter defaults to On.</p>
<p><strong>Important:</strong></p>
<p> We strongly recommend that you use TLS verification. Only connect to a server if you can verify its identity.</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 username to log in to the remote server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username to log in to the remote 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/execute_remote_whmapi1_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/execute_remote_whmapi1_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:R4kr31q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr31q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr31q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr31q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr31q:0" aria-labelledby="tab:R4kr31q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
execute_remote_whmapi1_with_password <span class="token punctuation">\</span>
<span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'host.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">'luggage12345'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">function</span><span class="token operator">=</span><span class="token string">'passwd'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">parameter_name</span><span class="token operator">=</span><span class="token string">'user'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">parameter_value</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:R4kr31q:1" aria-labelledby="tab:R4kr31q: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:R4sr31q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr31q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr31q:0" aria-labelledby="tab:R4sr31q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"app"</span>: <button class="collapser" aria-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">"key-name*"</span>: <span class="token string">"system"</span></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">"command"</span>: <span class="token string">"execute_remote_whmapi1_with_password"</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/API-Statistics" data-section-id="tag/API-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/API-Statistics" aria-label="tag/API-Statistics"></a>API Statistics</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>API Development Tools / API Statistics</p>
"><p>API Development Tools / API Statistics</p>
</div></div></div><div id="tag/API-Statistics/operation/get_api_calls" data-section-id="tag/API-Statistics/operation/get_api_calls" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_api_calls" id="operation/get_api_calls" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/API-Statistics/operation/get_api_calls" aria-label="tag/API-Statistics/operation/get_api_calls"></a>Return deprecated cPanel API 1 functions by date<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the cPanel API 1 functions that the system called on specific dates.
This is useful, for example, to check whether your system calls any cPanel API 1 functions.</p>
<p><strong>Important:</strong></p>
<p>The function <strong>only</strong> returns cPanel API 1 functions. We deprecated cPanel API 1 and plan
to remove those functions at a later date. For more information, read our
<a href="https://go.cpanel.net/replacecpapi1">Guide to Replacing cPanel API 1 Functions with UAPI Equivalents</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the cPanel API 1 functions that the system called on specific dates.
This is useful, for example, to check whether your system calls any cPanel API 1 functions.</p>
<p><strong>Important:</strong></p>
<p>The function <strong>only</strong> returns cPanel API 1 functions. We deprecated cPanel API 1 and plan
to remove those functions at a later date. For more information, read our
<a href="https://go.cpanel.net/replacecpapi1">Guide to Replacing cPanel API 1 Functions with UAPI Equivalents</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="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">"cpapi1"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=cpapi1</span></div><div><div html="<p>The cPanel API 1 function to query.</p>
<p><strong>Note:</strong></p>
<p><code>cpapi1</code> is the <strong>only</strong> possible value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel API 1 function to query.</p>
<p><strong>Note:</strong></p>
<p><code>cpapi1</code> is the <strong>only</strong> 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_api_calls</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_api_calls</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab51q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab51q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab51q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab51q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab51q:0" aria-labelledby="tab:R2ab51q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_api_calls
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab51q:1" aria-labelledby="tab:R2ab51q: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:R2eb51q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb51q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb51q:0" aria-labelledby="tab:R2eb51q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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 number">200000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"entry"</span>: <span class="token string">"Email::printdomainoptions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timestamp"</span>: <span class="token number">1548828000</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_api_calls"</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/API-Statistics/operation/get_api_pages" data-section-id="tag/API-Statistics/operation/get_api_pages" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_api_pages" id="operation/get_api_pages" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/API-Statistics/operation/get_api_pages" aria-label="tag/API-Statistics/operation/get_api_pages"></a>Return deprecated cPanel API 1 functions <!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the daily interface use of cPanel API 1 functions. Use this function to find out which API calls your custom interfaces or third-party plugins use.</p>
<p><strong>Important:</strong></p>
<p> The function <em>only</em> returns cPanel API 1 functions. We <em>deprecated</em> cPanel API 1 and plan to remove those functions at a later date. For more information, read our <a href="https://go.cpanel.net/replacecpapi1">Guide to Replacing cPanel API 1 Functions with UAPI Equivalents</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the daily interface use of cPanel API 1 functions. Use this function to find out which API calls your custom interfaces or third-party plugins use.</p>
<p><strong>Important:</strong></p>
<p> The function <em>only</em> returns cPanel API 1 functions. We <em>deprecated</em> cPanel API 1 and plan to remove those functions at a later date. For more information, read our <a href="https://go.cpanel.net/replacecpapi1">Guide to Replacing cPanel API 1 Functions with UAPI Equivalents</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="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">"cpapi1"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpapi1"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=cpapi1</span></div><div><div html="<p>The cPanel API type to query.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel API type 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_api_pages</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_api_pages</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ad51q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad51q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad51q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad51q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad51q:0" aria-labelledby="tab:R2ad51q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_api_pages
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad51q:1" aria-labelledby="tab:R2ad51q: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:R2ed51q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed51q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed51q:0" aria-labelledby="tab:R2ed51q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 number">200000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"entry"</span>: <span class="token string">"/usr/local/cpanel/base/frontend/jupiter/plugin1/index.html.tt"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timestamp"</span>: <span class="token number">1548828000</span></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">"command"</span>: <span class="token string">"get_api_pages"</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/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/api_token_create" data-section-id="tag/API-Token-Management/operation/api_token_create" class="sc-dntaoT ceciOs"><div data-section-id="operation/api_token_create" id="operation/api_token_create" 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/api_token_create" aria-label="tag/API-Token-Management/operation/api_token_create"></a>Create WHM API token<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates an API token. You can use API tokens instead of a password
or access hash key to execute WHM API 1 functions over HTTPS. For more information
about API tokens, read our
<a href="https://docs.cpanel.net/whm/development/manage-api-tokens-in-whm/">Manage API Tokens in WHM</a>
documentation.</p>
<p><strong>Important:</strong></p>
<p>You <strong>must</strong> call this function over an SSL connection.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates an API token. You can use API tokens instead of a password
or access hash key to execute WHM API 1 functions over HTTPS. For more information
about API tokens, read our
<a href="https://docs.cpanel.net/whm/development/manage-api-tokens-in-whm/">Manage API Tokens in WHM</a>
documentation.</p>
<p><strong>Important:</strong></p>
<p>You <strong>must</strong> call this function over an SSL connection.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="acl" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl</span></td><td class="sc-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">acl=acl-0=create-acct acl-1=list-accts acl-2=kill-acct</span> -<!-- --> <!-- -->Assign multiple privileges.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">acl=all</span> -<!-- --> <!-- -->Assign a single privilege.</li></ul><div><div html="<p>The privileges to assign to the token. If you do not use this parameter, the system
assigns <strong>all</strong> of your privileges to the token.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can <strong>only</strong> assign privileges that you possess to the API token.</li>
<li>To assign multiple privileges to the token, increment the parameter name. For
example: <code>acl-0</code>, <code>acl-1</code>, <code>acl-2</code>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The privileges to assign to the token. If you do not use this parameter, the system
assigns <strong>all</strong> of your privileges to the token.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can <strong>only</strong> assign privileges that you possess to the API token.</li>
<li>To assign multiple privileges to the token, increment the parameter name. For
example: <code>acl-0</code>, <code>acl-1</code>, <code>acl-2</code>.</li>
</ul>
</div></div></div></td></tr><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></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">expires_at=1609372800</span></div><div><div html="<p>The API token&#39;s expiration time. If you do not use this parameter, the
API token will not expire.</p>
<ul>
<li>A date, in <a href="http://en.wikipedia.org/wiki/Unix_time">Unix Epoch format</a>.</li>
<li><code>0</code> — The API token will <strong>not</strong> expire.</li>
</ul>
<p><strong>Important:</strong></p>
<p> When an API token expires, the system <strong>does</strong> not delete it. You <strong>must</strong>
manually delete expired API tokens.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token's expiration time. If you do not use this parameter, the
API token will not expire.</p>
<ul>
<li>A date, in <a href="http://en.wikipedia.org/wiki/Unix_time">Unix Epoch format</a>.</li>
<li><code>0</code> — The API token will <strong>not</strong> expire.</li>
</ul>
<p><strong>Important:</strong></p>
<p> When an API token expires, the system <strong>does</strong> not delete it. You <strong>must</strong>
manually delete expired API tokens.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="token_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">token_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">token_name=example</span></div><div><div html="<p>The API token&#39;s name.</p>
<p><strong>Note:</strong></p>
<ul>
<li>An API token name&#39;s maximum length is 50 characters, and the name may <strong>only</strong>
contain alphanumeric characters, dashes (<code>-</code>), and underscores (<code>_</code>).</li>
<li>You <strong>must</strong> assign a name that does <strong>not</strong> already exist to the API token.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token's name.</p>
<p><strong>Note:</strong></p>
<ul>
<li>An API token name's maximum length is 50 characters, and the name may <strong>only</strong>
contain alphanumeric characters, dashes (<code>-</code>), and underscores (<code>_</code>).</li>
<li>You <strong>must</strong> assign a name that does <strong>not</strong> already exist to the API token.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="whitelist_ip" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand whitelist_ip"><span class="property-name">whitelist_ip</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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">whitelist_ip=whitelist_ip-0=192.0.2.1 whitelist_ip-1=192.0.2.5 whitelist_ip-2=192.0.2.8/29 whitelist-ip-3=fc00:abcd::f whitelist-ip-4=2620:0:28a4::/48</span> -<!-- --> <!-- -->Assign multiple IP or CIDR ranges.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">whitelist_ip=192.0.2.8/29</span> -<!-- --> <!-- -->Assign a single IP or CIDR range.</li></ul><div><div html="<p>One or more optional remote IP or CIDR IP ranges this token may be used from. If you do not use this parameter, the system
does not limit which IPs can use this token.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To assign multiple whitelisted IPs to the token, increment the parameter name. For
example: <code>whitelist_ip-0</code>, <code>whitelist_ip-1</code>, <code>whitelist_ip-2</code>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>One or more optional remote IP or CIDR IP ranges this token may be used from. If you do not use this parameter, the system
does not limit which IPs can use this token.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To assign multiple whitelisted IPs to the token, increment the parameter name. For
example: <code>whitelist_ip-0</code>, <code>whitelist_ip-1</code>, <code>whitelist_ip-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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/api_token_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/api_token_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:R4kj71q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj71q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj71q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj71q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj71q:0" aria-labelledby="tab:R4kj71q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
api_token_create <span class="token punctuation">\</span>
<span class="token assign-left variable">token_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:R4kj71q:1" aria-labelledby="tab:R4kj71q: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:R4sj71q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj71q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj71q:0" aria-labelledby="tab:R4sj71q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"kill-acct"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_time"</span>: <span class="token number">1483625276</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">"name"</span>: <span class="token string">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">"UWU28DCA23NKY76CN17MDPKM3O7EFQY8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"whitelist_ips"</span>: <button class="collapser" aria-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><li><div class="hoverable "><span class="token string">"1.1.1.2"</span>,</div></li><li><div class="hoverable "><span class="token string">"1.1.1.8/29"</span>,</div></li><li><div class="hoverable "><span class="token string">"fc00:abcd:0000:0000:0000:0000:0000:000f"</span>,</div></li><li><div class="hoverable "><span class="token string">"2620:0000:28a4:0000:0000:0000:0000:0000/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">"metadata"</span>: <button class="collapser" aria-label="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">"api_token_create"</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/API-Token-Management/operation/api_token_revoke" data-section-id="tag/API-Token-Management/operation/api_token_revoke" class="sc-dntaoT ceciOs"><div data-section-id="operation/api_token_revoke" id="operation/api_token_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/api_token_revoke" aria-label="tag/API-Token-Management/operation/api_token_revoke"></a>Disable WHM API token<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function revokes an API token from the WHM account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function revokes an API token from the WHM 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="token_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">token_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> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">token_name=token_name-1=subway&token_name-2=job&token_name-3=jmkMRXBnhp20iz</span> -<!-- --> <!-- -->Revoke multiple API tokens.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">token_name=subway</span> -<!-- --> <!-- -->Revoke a single API token.</li></ul><div><div html="<p>The API token&#39;s name.</p>
<p><strong>Note:</strong></p>
<p>To revoke multiple API tokens, increment this parameter&#39;s name. For example: <code>token_name-1</code>, <code>token_name-2</code>, and <code>token_name-3</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token's name.</p>
<p><strong>Note:</strong></p>
<p>To revoke multiple API tokens, increment this parameter's name. For example: <code>token_name-1</code>, <code>token_name-2</code>, and <code>token_name-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="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">/api_token_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/api_token_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:R4kl71q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl71q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl71q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl71q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl71q:0" aria-labelledby="tab:R4kl71q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
api_token_revoke <span class="token punctuation">\</span>
<span class="token assign-left variable">token_name</span><span class="token operator">=</span><span class="token string">'subway'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl71q:1" aria-labelledby="tab:R4kl71q: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:R4sl71q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl71q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl71q:0" aria-labelledby="tab:R4sl71q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"api_token_revoke"</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/API-Token-Management/operation/api_token_list" data-section-id="tag/API-Token-Management/operation/api_token_list" class="sc-dntaoT ceciOs"><div data-section-id="operation/api_token_list" id="operation/api_token_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/api_token_list" aria-label="tag/API-Token-Management/operation/api_token_list"></a>Return WHM API tokens<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists a WHM account&#39;s API tokens.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a WHM 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/api_token_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/api_token_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:R4kn71q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn71q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn71q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn71q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn71q:0" aria-labelledby="tab:R4kn71q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
api_token_list
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn71q:1" aria-labelledby="tab:R4kn71q: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:R4sn71q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn71q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn71q:0" aria-labelledby="tab:R4sn71q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"tokens"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"my-controller-token"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acls"</span>: <button class="collapser" aria-label="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-acct"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit-account"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit-bandwidth"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"list-accts"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspend-acct"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"upgrade-account"</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">"create_time"</span>: <span class="token number">1483625276</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">"name"</span>: <span class="token string">"my-controller-token"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"whitelist_ips"</span>: <button class="collapser" aria-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.0.2.1"</span>,</div></li><li><div class="hoverable "><span class="token string">"192.0.2.2"</span>,</div></li><li><div class="hoverable "><span class="token string">"192.0.2.8/29"</span>,</div></li><li><div class="hoverable "><span class="token string">"fc00:abcd:0000:0000:0000:0000:0000:000f"</span>,</div></li><li><div class="hoverable "><span class="token string">"2620:0000:28a4:0000:0000:0000:0000:0000/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">"my-read-only-token"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acls"</span>: <button class="collapser" aria-label="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-acct"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit-account"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit-bandwidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"list-accts"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspend-acct"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"upgrade-account"</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">"create_time"</span>: <span class="token number">1490882281</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</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">"my-read-only-token"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"whitelist_ips"</span>: <span class="token keyword">null</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">"metadata"</span>: <button class="collapser" aria-label="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">"api_token_list"</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/API-Token-Management/operation/api_token_update" data-section-id="tag/API-Token-Management/operation/api_token_update" class="sc-dntaoT ceciOs"><div data-section-id="operation/api_token_update" id="operation/api_token_update" 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/api_token_update" aria-label="tag/API-Token-Management/operation/api_token_update"></a>Update WHM API token's settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function updates an API token&#39;s settings.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates an API token'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=""><td kind="field" title="acl" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl</span></td><td class="sc-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">acl=acl-0=create-acct acl-1=list-accts acl-2=kill-acct</span> -<!-- --> <!-- -->Assign multiple privilges.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">acl=all</span> -<!-- --> <!-- -->Assign a single privilege.</li></ul><div><div html="<p>The new privileges to assign to the token. If you do <strong>not</strong> use this parameter,
the system will assign all of your privileges to the token.</p>
<p>For a list of Access Control List (ACL) privileges, read our
<a href="https://docs.cpanel.net/whm/resellers/edit-reseller-nameservers-and-privileges/#feature-limits-acl-lists">Edit Reseller Nameservers and Privileges</a>
documentation.</p>
<p><strong>Note:</strong></p>
<ul>
<li><p>You can <strong>only</strong> assign privileges that you possess to the API token.</p>
</li>
<li><p>The function replaces <strong>all</strong> current privileges with the privileges that you pass
in this parameter.</p>
</li>
<li><p>To assign multiple privileges to the token, increment the parameter name.
For example, <code>acl-1</code>, <code>acl-2</code>, <code>acl-3</code>.</p>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new privileges to assign to the token. If you do <strong>not</strong> use this parameter,
the system will assign all of your privileges to the token.</p>
<p>For a list of Access Control List (ACL) privileges, read our
<a href="https://docs.cpanel.net/whm/resellers/edit-reseller-nameservers-and-privileges/#feature-limits-acl-lists">Edit Reseller Nameservers and Privileges</a>
documentation.</p>
<p><strong>Note:</strong></p>
<ul>
<li><p>You can <strong>only</strong> assign privileges that you possess to the API token.</p>
</li>
<li><p>The function replaces <strong>all</strong> current privileges with the privileges that you pass
in this parameter.</p>
</li>
<li><p>To assign multiple privileges to the token, increment the parameter name.
For example, <code>acl-1</code>, <code>acl-2</code>, <code>acl-3</code>.</p>
</li>
</ul>
</div></div></div></td></tr><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"> <!-- -->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">expires_at=1609372800</span></div><div><div html="<p>The API token&#39;s expiration time. If you do not use this parameter,
the API token will <strong>not</strong> expire.</p>
<ul>
<li>A date, in <a href="http://en.wikipedia.org/wiki/Unix_time">Unix Epoch format</a>.</li>
<li><code>0</code> — The API token will <strong>not</strong> expire.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When an API token expires, the system does <strong>not</strong> delete it. You <strong>must</strong>
manually delete expired API tokens.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token's expiration time. If you do not use this parameter,
the API token will <strong>not</strong> expire.</p>
<ul>
<li>A date, in <a href="http://en.wikipedia.org/wiki/Unix_time">Unix Epoch format</a>.</li>
<li><code>0</code> — The API token will <strong>not</strong> expire.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When an API token expires, the system does <strong>not</strong> delete it. You <strong>must</strong>
manually delete expired API tokens.</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><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=example</span></div><div><div html="<p>The API token&#39;s new name. If you do not use this parameter, the API token&#39;s name
remains the same.</p>
<p><strong>Note:</strong></p>
<ul>
<li><p>An API token name&#39;s maximum length is 50 characters, and the name may <strong>only</strong>
contain alphanumeric characters, dashes (<code>-</code>), and underscores (<code>_</code>).</p>
</li>
<li><p>You <strong>must</strong> assign a name that does <strong>not</strong> already exist to the API token.</p>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token's new name. If you do not use this parameter, the API token's name
remains the same.</p>
<p><strong>Note:</strong></p>
<ul>
<li><p>An API token name's maximum length is 50 characters, and the name may <strong>only</strong>
contain alphanumeric characters, dashes (<code>-</code>), and underscores (<code>_</code>).</p>
</li>
<li><p>You <strong>must</strong> assign a name that does <strong>not</strong> already exist to the API token.</p>
</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="token_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">token_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">token_name=token</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="whitelist_ip" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand whitelist_ip"><span class="property-name">whitelist_ip</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">whitelist_ip=whitelist_ip=any</span> -<!-- --> <!-- -->Clear a token's whitelisted IPs list.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">whitelist_ip=whitelist_ip-0=192.0.2.1 whitelist_ip-1=192.0.2.5 whitelist_ip-2=192.0.2.8/29 whitelist-ip-3=fc00:abcd::f whitelist-ip-4=2620:0:28a4::/48</span> -<!-- --> <!-- -->Assign multiple IPs or CIDR ranges.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">whitelist_ip=whitelist_ip=192.0.2.8/29</span> -<!-- --> <!-- -->Assign a single IP or CIDR range.</li></ul><div><div html="<p>The new remote IP or CIDR IP ranges to assign to this token. If you do not use this parameter, the system
does not limit which IPs can use this token.</p>
<p><strong>Note:</strong></p>
<ul>
<li><p>The function replaces <strong>all</strong> current whitelisted IPs with the IPs you pass
in this parameter.</p>
</li>
<li><p>To assign multiple whitelisted IPs to the token, increment the parameter name. For
example: <code>whitelist_ip-0</code>, <code>whitelist_ip-1</code>, <code>whitelist_ip-2</code>.</p>
</li>
<li><p>If a token has whitelisted IPs set, they can be cleared by passing <code>whitelist_ip=any</code> as a parameter.
This will allow any IP to make API calls using that token.</p>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new remote IP or CIDR IP ranges to assign to this token. If you do not use this parameter, the system
does not limit which IPs can use this token.</p>
<p><strong>Note:</strong></p>
<ul>
<li><p>The function replaces <strong>all</strong> current whitelisted IPs with the IPs you pass
in this parameter.</p>
</li>
<li><p>To assign multiple whitelisted IPs to the token, increment the parameter name. For
example: <code>whitelist_ip-0</code>, <code>whitelist_ip-1</code>, <code>whitelist_ip-2</code>.</p>
</li>
<li><p>If a token has whitelisted IPs set, they can be cleared by passing <code>whitelist_ip=any</code> as a parameter.
This will allow any IP to make API calls using that token.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/api_token_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/api_token_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:R4kp71q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp71q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp71q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp71q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp71q:0" aria-labelledby="tab:R4kp71q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
api_token_update <span class="token punctuation">\</span>
<span class="token assign-left variable">token_name</span><span class="token operator">=</span><span class="token string">'token'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp71q:1" aria-labelledby="tab:R4kp71q: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:R4sp71q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp71q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp71q:0" aria-labelledby="tab:R4sp71q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acls"</span>: <button class="collapser" aria-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-acct"</span>,</div></li><li><div class="hoverable "><span class="token string">"kill-acct"</span>,</div></li><li><div class="hoverable "><span class="token string">"list-accts"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_time"</span>: <span class="token number">1483625276</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">"name"</span>: <span class="token string">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"whitelist_ips"</span>: <button class="collapser" aria-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.0.2.1"</span>,</div></li><li><div class="hoverable "><span class="token string">"192.0.2.2"</span>,</div></li><li><div class="hoverable "><span class="token string">"192.0.2.8/29"</span>,</div></li><li><div class="hoverable "><span class="token string">"fc00:abcd:0000:0000:0000:0000:0000:000f"</span>,</div></li><li><div class="hoverable "><span class="token string">"2620:0000:28a4:0000:0000:0000:0000:0000/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">"metadata"</span>: <button class="collapser" aria-label="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">"api_token_update"</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/API-Token-Management/operation/api_token_get_details" data-section-id="tag/API-Token-Management/operation/api_token_get_details" class="sc-dntaoT ceciOs"><div data-section-id="operation/api_token_get_details" id="operation/api_token_get_details" 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/api_token_get_details" aria-label="tag/API-Token-Management/operation/api_token_get_details"></a>Look up API token details<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function looks up an API token’s details based on the token itself.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function looks up an API token’s details based on the token itself.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="token" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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">token=GVJWD78FF12NMBFKYKPS9BJ483C0XSQH</span></div><div><div html="<p>The API token.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><div><span class="sc-geXuza dSHOzv"> <!-- -->Any of<!-- --> </span><div class="sc-eUlrpB NyAuz"><button class="sc-hJRrWL dhcDOu">Token Recognized</button><button class="sc-hJRrWL kXIkjx">Token Unrecognized</button></div><div></div><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><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 API token’s details. Only present if the system recognizes the given <code>token</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token’s details. Only present if the system recognizes the given <code>token</code>.</p>
</div></div></div></td></tr><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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->Metadata<!-- -->) </span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/api_token_get_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/api_token_get_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:R4kr71q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr71q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr71q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr71q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr71q:0" aria-labelledby="tab:R4kr71q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
api_token_get_details <span class="token punctuation">\</span>
<span class="token assign-left variable">token</span><span class="token operator">=</span>GVJWD78FF12NMBFKYKPS9BJ483C0XSQH
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr71q:1" aria-labelledby="tab:R4kr71q: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:R4sr71q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr71q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr71q:0" aria-labelledby="tab:R4sr71q:0"><div><div class="sc-Rjrgp dIDLbO"><span 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="Token Recognized" selected="">Token Recognized</option><option value="Token Unrecognized">Token Unrecognized</option></select><label>Token Recognized</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">"acls"</span>: <button class="collapser" aria-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-acct"</span>,</div></li><li><div class="hoverable "><span class="token string">"kill-acct"</span>,</div></li><li><div class="hoverable "><span class="token string">"list-accts"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_time"</span>: <span class="token number">1483625276</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">"name"</span>: <span class="token string">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"whitelist_ips"</span>: <button class="collapser" aria-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.0.2.1"</span>,</div></li><li><div class="hoverable "><span class="token string">"192.0.2.2"</span>,</div></li><li><div class="hoverable "><span class="token string">"192.0.2.8/29"</span>,</div></li><li><div class="hoverable "><span class="token string">"fc00:abcd:0000:0000:0000:0000:0000:000f"</span>,</div></li><li><div class="hoverable "><span class="token string">"2620:0000:28a4:0000:0000:0000:0000:0000/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">"metadata"</span>: <button class="collapser" aria-label="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">"api_token_get_details"</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><div id="tag/Applications" data-section-id="tag/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/Applications" aria-label="tag/Applications"></a>Applications</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>API Development Tools / Applications</p>
"><p>API Development Tools / Applications</p>
</div></div></div><div id="tag/Applications/operation/applist" data-section-id="tag/Applications/operation/applist" class="sc-dntaoT ceciOs"><div data-section-id="operation/applist" id="operation/applist" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Applications/operation/applist" aria-label="tag/Applications/operation/applist"></a>Return WHM API 1 functions list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists available WHM API 1 functions.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists available WHM API 1 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/applist</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/applist</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab91q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab91q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab91q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab91q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab91q:0" aria-labelledby="tab:R2ab91q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
applist
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab91q:1" aria-labelledby="tab:R2ab91q: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:R2eb91q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb91q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb91q:0" aria-labelledby="tab:R2eb91q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"app"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"accountsummary"</span>,</div></li><li><div class="hoverable "><span class="token string">"listaccts"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"applist"</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/Applications/operation/get_appconfig_application_list" data-section-id="tag/Applications/operation/get_appconfig_application_list" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_appconfig_application_list" id="operation/get_appconfig_application_list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Applications/operation/get_appconfig_application_list" aria-label="tag/Applications/operation/get_appconfig_application_list"></a>Return registered applications<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists registered <a href="https://go.cpanel.net/appconfig">AppConfig</a> applications.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists registered <a href="https://go.cpanel.net/appconfig">AppConfig</a> applications.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_appconfig_application_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_appconfig_application_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:R2ad91q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad91q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad91q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad91q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad91q:0" aria-labelledby="tab:R2ad91q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_appconfig_application_list
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad91q:1" aria-labelledby="tab:R2ad91q: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:R2ed91q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed91q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed91q:0" aria-labelledby="tab:R2ed91q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cpanel"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"any"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><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">"entryurl"</span>: <span class="token string">"roundcube/"</span><span class="token punctuation">,</span></div></li><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">"roundcube"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"mailman"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <span class="token string">"roundcube.ico"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"roundcube"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"origin"</span>: <span class="token string">"clamavconnector.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phpConfig"</span>: <span class="token string">"php.ini"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">"_self"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"upgradecall"</span>: <span class="token string">"/usr/local/roundcube/bin/upgrade"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"/3rdparty/roundcube"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"roundcube"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webmail"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"any"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><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">"entryurl"</span>: <span class="token string">"roundcube/"</span><span class="token punctuation">,</span></div></li><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">"roundcube"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"mailman"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <span class="token string">"roundcube.ico"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"roundcube"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"origin"</span>: <span class="token string">"clamavconnector.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phpConfig"</span>: <span class="token string">"php.ini"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">"_self"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"upgradecall"</span>: <span class="token string">"/usr/local/roundcube/bin/upgrade"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"/3rdparty/roundcube"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"roundcube"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"whostmgr"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"any"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><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">"entryurl"</span>: <span class="token string">"roundcube/"</span><span class="token punctuation">,</span></div></li><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">"roundcube"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"mailman"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <span class="token string">"roundcube.ico"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"roundcube"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"origin"</span>: <span class="token string">"clamavconnector.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phpConfig"</span>: <span class="token string">"php.ini"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">"_self"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"upgradecall"</span>: <span class="token string">"/usr/local/roundcube/bin/upgrade"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"/3rdparty/roundcube"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"roundcube"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_appconfig_application_list"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Got application list"</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/Session" data-section-id="tag/Session" 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/Session" aria-label="tag/Session"></a>Session</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>API Development Tools / Session</p>
"><p>API Development Tools / Session</p>
</div></div></div><div id="tag/Session/operation/create_user_session" data-section-id="tag/Session/operation/create_user_session" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_user_session" id="operation/create_user_session" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Session/operation/create_user_session" aria-label="tag/Session/operation/create_user_session"></a>Create a temporary user session<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates a new temporary user session for a specified service.
This allows users with WHM access to log in to third-party applications
(for example, billing systems) without storing the account password.</p>
<p><strong>Note:</strong></p>
<ul>
<li>The system destroys the temporary session after 15 minutes of inactivity.</li>
<li>For more information about the Single Sign On feature, read our
<a href="/whm/tokens/">Guide to API Authentication</a>
documentation.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a new temporary user session for a specified service.
This allows users with WHM access to log in to third-party applications
(for example, billing systems) without storing the account password.</p>
<p><strong>Note:</strong></p>
<ul>
<li>The system destroys the temporary session after 15 minutes of inactivity.</li>
<li>For more information about the Single Sign On feature, read our
<a href="/whm/tokens/">Guide to API Authentication</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=""><td kind="field" title="app" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">app</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"Backups_Home"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Calendar_Configure"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ContactInfo_Change"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Cron_Home"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Database_MySQL"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Database_phpMyAdmin"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Domains_AddonDomains"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Domains_SubDomains"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Email_AccountLevelFiltering"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Email_Accounts"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Email_Archive"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Email_Authentication"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Email_AutoResponders"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Email_BoxTrapper"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Email_DefaultAddress"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Email_DeliveryReport"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Email_Forwarders"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Email_GreyListing"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Email_MailingLists"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Email_MX"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Email_SpamFilter"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Email_UserLevelFiltering"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"FileManager_Home"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Locale_Change"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Password_Change"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Site_Software"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Site_Software_*"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Stats_AWStats"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"WHMCS_billing"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"add_a_dns_zone"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"add_an_a_entry_for_your_hostname"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"add_a_new_ip_address"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"add_a_package"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"additional_mysql_access_hosts"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"add_remove_recognized_ip_addresses"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"apache_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"apache_mod_userdir_tweak"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"apache_status"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"api_shell"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"api_tokens"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"apps_managed_by_appconfig"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"assign_ipv6_address"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"background_process_killer"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"backup_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"backup_restoration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"backup_system_migration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"backup_user_selection"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"basic_webhost_manager_setup"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"blocker"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"change_account_contact_email"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"change_hostname"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"change_log"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"change_multiple_sites_ip_addresses"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"change_mysql_user_password"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"change_ownership_of_an_account"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"change_ownership_of_multiple_accounts"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"change_root_password"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"change_sites_ip_address"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cloudlinux_lve_manager"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"compiler_access"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"configuration_cluster"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"configure_application_locales"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"configure_cpanel_analytics"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"configure_cpanel_cron_jobs"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"configure_postgresql"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"configure_remote_service_ips"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"configure_security_policies"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"contact_manager"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"convert_addon_domain_to_account"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"copy_a_locale"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"copy_an_account_from_another_server_with_an_account_password"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpanel_development_forum"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpanel_log_rotation_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpanel_plugin_file_generator"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpanel_web_disk_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpanel_web_services_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cphulk_brute_force_protection"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"create_a_new_account"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"create_support_ticket"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"customization"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"daily_process_log"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"database_map_tool"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"delete_a_dns_zone"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"delete_a_locale"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"delete_a_package"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"directoryindex_priority"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"dns_cluster"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"dns_server"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"easyapache_4"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"edit_a_locale"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"edit_a_package"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"edit_backup_mx_hosts"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"edit_blacklisted_smtp_ips"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"edit_dns_zone"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"edit_mx_entry"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"edit_only_verify_recipient_smtp_hosts"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"edit_questions_and_answers"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"edit_reseller_name_servers_and_privileges"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"edit_sender_verification_bypass_ips"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"edit_system_mail_preferences"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"edit_trusted_smtp_ips"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"edit_zone_templates"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"email_all_resellers"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"email_all_users"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"email_deliverability"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"enable_dkim_and_spf_globally"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"exim_configuration_manager"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"feature_manager"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"file_and_directory_restoration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"forceful_server_reboot"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"force_password_change"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ftp_server_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ftp_server_proftpd_pureftpd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ftp_server_selection"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"generate_an_ssl_certificate_and_signing_request"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"global_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"graceful_server_reboot"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"grant_cpanel_support_access"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"greylisting"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"host_access_control"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"http_server_apache"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ico-security-advisor"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"imap_server"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"include_editor"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"initial_quota_setup"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"install_an_rpm"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"install_an_ssl_certificate_on_a_domain"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"install_a_perl_module"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"install_a_perl_module_process"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"install_cpaddons_site_software"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ip_migration_wizard"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ipv6_ranges"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"legacy_backup_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"legacy_language_file_upload"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"legacy_restore_backups"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"legacy_restore_multiple_backups"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"legacy_restore_multiple_backups_confirmation"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"limit_bandwidth_usage"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"list_accounts"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"list_parked_domains"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"list_subdomains"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"list_suspended_accounts"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"locale_editor"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"locale_xml_download"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"locale_xml_upload"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"log_rotation"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mailbox_conversion"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mail_delivery_reports"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mailing_list_manager_mailman"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mail_queue_manager"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mailserver_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mail_server_exim"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mail_troubleshooter"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_account_suspension"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_autossl"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_compiler_group"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_cpaddons_site_software"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_custom_rbls"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_databases"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_database_users"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_demo_mode"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_external_authentication"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_external_authentication_providers"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_external_authentication_users"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_hooks"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_mysql_profiles"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_plugins"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_resellers_ip_delegation"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_resellers_shared_ip"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_roots_ssh_keys"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_services_ssl_certificates"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_shell_access"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_ssl_hosts"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manage_wheel_group_users"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"market_provider_manager"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"memory_usage_restrictions"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"modify_an_account"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"modify_cpanel_whm_news"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"modify_upgrade_multiple_accounts"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"modsecurity_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"modsecurity_tools"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"modsecurity_vendors"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"module_installers"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"multiphp_ini_editor"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"multiphp_manager"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mysql_mariadb_upgrade"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mysql_root_password"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"nameserver_record_report"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"nameserver_selection"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"non_standard_locale_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"park_a_domain"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"password_modification"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"password_strength_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"perform_a_dns_cleanup"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"php_fpm_service_for_apache"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"phpMyAdmin"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"piped_log_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"process_manager"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"purchase_and_install_an_ssl_certificate"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"quota_modification"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"raw_apache_log_download"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"raw_ftp_log_download"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"rearrange_an_account"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"rebuild_rpm_database"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"rebuild_the_ip_address_pool"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"remote_access_key"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"repair_a_mysql_database"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"repair_mailbox_permissions"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"reseller_center"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"reserved_ips_editor"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"reset_account_bandwidth_limit"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"reset_a_dns_zone"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"reset_a_mailman_password"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"reset_resellers"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"resolver_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"restore_a_full_backup_cpmove_file"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"restore_modules_summary"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"review_transfers_and_restores"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"security_questions"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"server_information"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"server_profile"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"server_time"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"service_manager"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"service_status"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"setup_edit_domain_forwarding"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"set_zone_time_to_live_ttl"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"shell_fork_bomb_protection"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"show_accounts_over_quota"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"show_current_disk_usage"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"show_current_running_processes"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"show_edit_reserved_ips"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"show_ip_address_usage"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"show_mysql_processes"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"show_or_delete_current_ip_addresses"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"show_reseller_accounts"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"skeleton_directory"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"smtp_restrictions"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"software_development_kit"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"spamd_startup_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"sql_server_mysql"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"sql_server_pgsql"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ssh_password_authorization_tweak"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ssh_server_openssh"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ssl_storage_manager"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"statistics_software_configuration"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"support_center"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"synchronize_dns_records"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"system_update"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"task_queue_monitor"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"terminal"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"terminate_accounts"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"theme_manager"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"traceroute_enable_disable"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"transfer_tool"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"tweak_settings"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"two_factor_authentication"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"unsuspend_bandwidth_exceeders"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"update_database_map"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"update_database_map_process"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"update_preferences"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"update_server_software"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"upgrade_downgrade_an_account"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"upgrade_to_latest_version"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"view_available_locales"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"view_bandwidth_usage"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"view_mail_statistics_summary"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"view_relayers"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"view_reseller_usage_and_manage_account_status"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"view_sent_summary"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"web_template_editor"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">app=Backups_Home</span></div><div><div html="<p>The cPanel or WHM application to which the session will link. This
parameter defaults to a blank string, which redirects the user to the
cPanel
<a href="https://docs.cpanel.net/cpanel/the-cpanel-interface/the-cpanel-interface/"><em>Home</em></a>
interface.</p>
<ul>
<li>A valid application name, to link the session to an application.</li>
<li>An invalid application name, to create the session but <strong>not</strong> link
it to an application.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel or WHM application to which the session will link. This
parameter defaults to a blank string, which redirects the user to the
cPanel
<a href="https://docs.cpanel.net/cpanel/the-cpanel-interface/the-cpanel-interface/"><em>Home</em></a>
interface.</p>
<ul>
<li>A valid application name, to link the session to an application.</li>
<li>An invalid application name, to create the session but <strong>not</strong> link
it to an application.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="cp_security_token" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cp_security_token</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cp_security_token=cpsess1234567890</span></div><div><div html="<p>The session&#39;s security token.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The session's security token.</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=fr</span></div><div><div html="<p>The session&#39;s locale. This parameter defaults to the <em>Server Locale</em> setting in WHM&#39;s
<a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/#system"><em>Tweak Settings</em></a>
interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>).</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you specify a locale, the server sends a cookie to your browser with
that locale setting. The cookie expires after one year.</li>
<li>Users can change the locale with the language options at the bottom of
the login interface.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The session's locale. This parameter defaults to the <em>Server Locale</em> setting in WHM's
<a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/#system"><em>Tweak Settings</em></a>
interface (<em>WHM >> Home >> Server Configuration >> Tweak Settings</em>).</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you specify a locale, the server sends a cookie to your browser with
that locale setting. The cookie expires after one year.</li>
<li>Users can change the locale with the language options at the bottom of
the login interface.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="preferred_domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">preferred_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">preferred_domain=example.com</span></div><div><div html="<p>The hostname or IP address for the function to use in the <code>url</code>
return. This parameter&#39;s value defaults to the server&#39;s hostname.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hostname or IP address for the function to use in the <code>url</code>
return. This parameter's value defaults to the server's hostname.</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">"cpaneld"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"whostmgrd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"webmaild"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service=cpaneld</span></div><div><div html="<p>The session&#39;s service.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The session's service.</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=user@example.com</span></div><div><div html="<p>The session&#39;s cPanel account username or a valid email address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The session's cPanel account username or a valid 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/create_user_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/create_user_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:R157b1q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R157b1q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R157b1q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R157b1q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R157b1q:0" aria-labelledby="tab:R157b1q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
create_user_session <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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">service</span><span class="token operator">=</span><span class="token string">'cpaneld'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R157b1q:1" aria-labelledby="tab:R157b1q: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:R177b1q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R177b1q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R177b1q:0" aria-labelledby="tab:R177b1q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cp_security_token"</span>: <span class="token string">"/cpsess1234567890"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires"</span>: <span class="token number">1401993893</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"cpaneld"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"session"</span>: <span class="token string">"username:RFw6MUp9S8sRwTSgqaUJWUCq8ZQg2Zkopx5KaTHRNQXBfT3n8xvfBEF9JJC3iiwa"</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:2083/cpsess1234567890/login/?session=username:RFw6MUp9S8sRwTSgqaUJWUCq8ZQg2Zkopx5KaTHRNQXBfT3n8xvfBEF9JJC3iiwa&locale=fr">https://example.com:2083/cpsess1234567890/login/?session=username:RFw6MUp9S8sRwTSgqaUJWUCq8ZQg2Zkopx5KaTHRNQXBfT3n8xvfBEF9JJC3iiwa&locale=fr</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">"metadata"</span>: <button class="collapser" aria-label="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">"create_user_session"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Created session"</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/Authentication-Providers" data-section-id="tag/Authentication-Providers" 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/Authentication-Providers" aria-label="tag/Authentication-Providers"></a>Authentication Providers</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Authentication / Authentication Providers</p>
"><p>Authentication / Authentication Providers</p>
</div></div></div><div id="tag/Authentication-Providers/operation/unlink_user_authn_provider" data-section-id="tag/Authentication-Providers/operation/unlink_user_authn_provider" class="sc-dntaoT ceciOs"><div data-section-id="operation/unlink_user_authn_provider" id="operation/unlink_user_authn_provider" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Authentication-Providers/operation/unlink_user_authn_provider" aria-label="tag/Authentication-Providers/operation/unlink_user_authn_provider"></a>Unregister cPanel account from authentication provider<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function unlinks a cPanel account from an external authentication identity provider.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function unlinks a cPanel account from 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_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=cpanelid</span></div><div><div html="<p>The system&#39;s internal key for the identity provider.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The system's internal key for 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></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 account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 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="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">/unlink_user_authn_provider</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/unlink_user_authn_provider</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R15732a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R15732a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R15732a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R15732a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R15732a:0" aria-labelledby="tab:R15732a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
unlink_user_authn_provider <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">'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:R15732a:1" aria-labelledby="tab:R15732a: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:R17732a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R17732a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R17732a:0" aria-labelledby="tab:R17732a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"unlink_user_authn_provider"</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/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/disable_failing_authentication_providers" data-section-id="tag/External-Authentication/operation/disable_failing_authentication_providers" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_failing_authentication_providers" id="operation/disable_failing_authentication_providers" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/External-Authentication/operation/disable_failing_authentication_providers" aria-label="tag/External-Authentication/operation/disable_failing_authentication_providers"></a>Disable identity provider modules that fail to load<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function disables any enabled identity provider modules that fail to load.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables any enabled identity provider modules that fail to load.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/disable_failing_authentication_providers</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/disable_failing_authentication_providers</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99352a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99352a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99352a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99352a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99352a:0" aria-labelledby="tab:R99352a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
disable_failing_authentication_providers
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99352a:1" aria-labelledby="tab:R99352a: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:R9p352a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p352a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p352a:0" aria-labelledby="tab:R9p352a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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_services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"cpaneld"</span>,</div></li><li><div class="hoverable "><span class="token string">"webmaild"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failures_to_disable"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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"</span>: <span class="token string">"An informative failure message."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service_name"</span>: <span class="token string">"whostmgrd"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_failure"</span>: <span class="token string">"(ERR mcddbv) The system failed to load the module “Cpanel::Security::Authn::Provider::Facebook“ because of an error: Can't locate Cpanel/Security/Authn/Provider/Facebook.pm in @INC (@INC contains: /usr/local/cpanel /usr/local/cpanel/3rdparty/perl/514/lib/perl5/cpanel_lib/i386-linux-64int /usr/local/cpanel/3rdparty/perl/514/lib/perl5/cpanel_lib /usr/local/cpanel/3rdparty/perl/514/lib/perl5/5.14.4/i386-linux-64int /usr/local/cpanel/3rdparty/perl/514/lib/perl5/5.14.4 /opt/cpanel/perl5/514/site_lib/i386-linux-64int /opt/cpanel/perl5/514/site_lib /var/cpanel/perl) at (eval 143) line 1.\nBEGIN failed--compilation aborted at (eval 143) line 1.\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">"facebook"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_namespace"</span>: <span class="token string">"Cpanel::Security::Authn::Provider::Facebook"</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">"metadata"</span>: <button class="collapser" aria-label="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">"disable_failing_authentication_providers"</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/External-Authentication/operation/get_available_authentication_providers" data-section-id="tag/External-Authentication/operation/get_available_authentication_providers" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_available_authentication_providers" id="operation/get_available_authentication_providers" 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_available_authentication_providers" aria-label="tag/External-Authentication/operation/get_available_authentication_providers"></a>Return available identity providers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists available external authentication identity providers for all services.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists available external authentication identity providers for all services.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_available_authentication_providers</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_available_authentication_providers</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99552a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99552a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99552a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99552a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99552a:0" aria-labelledby="tab:R99552a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_available_authentication_providers
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99552a:1" aria-labelledby="tab:R99552a: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:R9p552a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p552a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p552a:0" aria-labelledby="tab:R9p552a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"providers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"dd4b39"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"configured"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpaneld_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpaneld_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">"display_name"</span>: <span class="token string">"cPanel"</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/cpanelidmanage">https://go.cpanel.net/cpanelidmanage</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">"Click to view...iVBORw0KGgoAAAANSUhEUgAAACEAAAAhCAYAAABX5MJvAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAV1JREFUeNrsVtGNwjAMJegGYIRucBmhtwEjdAMyQjYoG2SEG6HcBGUDugFskHOQg1zTlFaN\\/\\/KkqMh2yYvt53S3KygomIZaE+y9P8BDJ9xXpdSDxT9jwX7dxDJsDMvCuvl33GF1sBwS5O8GX7eVgCabGyRkGJF25v0sJHrcyDH7iMhWEl9zWSD1\\/xs1klJn8J\\/gZ4WxNdgu8KyiDXGIfmJ7LO6R8CI5rJnwO+Kv0Wb9Z7xlZr+wMt8f\\/ANmyCoCMF3CUmP8rOmHip1AM\\/8tdbLcjfnL5NigYmIp+ilp5iYRJNkmajtLIBuJiUZ1S+aDKGDjI8tGk+N\\/9yuy0ODcGIjL8UEmcXKLDelRDQ5tHcuIkSLQE1WYhIRfMRIEmiV1Z7NES5Rh9nIisRGVWGOyyyflC5fSkDsTmk1KnVBMbForqQw+IVtUCP3KEpdojffHnRGKcq3LZ3pBgST+BRgANXt+WPKE7tYAAAAASUVORK5CYII="</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">"id"</span>: <span class="token string">"cpanelid"</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 cPanelID Account"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">"cpanel"</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webmaild_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webmaild_link"</span>: <span class="token string">"</span><a href="https://hostname.example.com:2096/openid_connect/cpanelid">https://hostname.example.com:2096/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">"whostmgr_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"whostmgrd_link"</span>: <span class="token string">"</span><a href="https://hostname.example.com:2087/openid_connect/cpanelid">https://hostname.example.com:2087/openid_connect/cpanelid</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_available_authentication_providers"</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/External-Authentication/operation/enable_authentication_provider" data-section-id="tag/External-Authentication/operation/enable_authentication_provider" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_authentication_provider" id="operation/enable_authentication_provider" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/External-Authentication/operation/enable_authentication_provider" aria-label="tag/External-Authentication/operation/enable_authentication_provider"></a>Enable identity provider<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables an external authentication identity provider for a specified service.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables an external authentication identity provider for a specified 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="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=cpanelid</span></div><div><div html="<p>A valid identity provider&#39;s identification key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A valid identity provider's identification key.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="service_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">service_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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpaneld"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"webmaild"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"whostmgrd"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service_name=cpaneld</span></div><div><div html="<p>The cPanel &amp; WHM service&#39;s name:</p>
<ul>
<li><code>cpaneld</code></li>
<li><code>webmaild</code></li>
<li><code>whostmgrd</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel & WHM service's name:</p>
<ul>
<li><code>cpaneld</code></li>
<li><code>webmaild</code></li>
<li><code>whostmgrd</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="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">/enable_authentication_provider</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/enable_authentication_provider</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99752a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99752a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99752a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99752a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99752a:0" aria-labelledby="tab:R99752a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
enable_authentication_provider <span class="token punctuation">\</span>
<span class="token assign-left variable">service_name</span><span class="token operator">=</span><span class="token string">'cpaneld'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">provider_id</span><span class="token operator">=</span><span class="token string">'cpanelid'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99752a:1" aria-labelledby="tab:R99752a: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:R9p752a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p752a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p752a:0" aria-labelledby="tab:R9p752a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"enable_authentication_provider"</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/External-Authentication/operation/get_provider_client_configurations" data-section-id="tag/External-Authentication/operation/get_provider_client_configurations" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_provider_client_configurations" id="operation/get_provider_client_configurations" 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_provider_client_configurations" aria-label="tag/External-Authentication/operation/get_provider_client_configurations"></a>Return identity provider client configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the configuration details for the client of an external authentication identity provider.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the configuration details for the client of 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_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=cpanelid</span></div><div><div html="<p>The identity provider&#39;s key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The identity provider's key.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="service_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">service_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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpaneld"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"whostmgrd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"webmaild"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service_name=cpaneld</span></div><div><div html="<p>The cPanel &amp; WHM service&#39;s name.</p>
<ul>
<li><code>cpaneld</code> — The cPanel daemon.</li>
<li><code>whostmgrd</code> — The WHM daemon.</li>
<li><code>webmaild</code> — The Webmail daemon.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel & WHM service's name.</p>
<ul>
<li><code>cpaneld</code> — The cPanel daemon.</li>
<li><code>whostmgrd</code> — The WHM daemon.</li>
<li><code>webmaild</code> — The Webmail daemon.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_provider_client_configurations</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_provider_client_configurations</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99952a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99952a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99952a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99952a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99952a:0" aria-labelledby="tab:R99952a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_provider_client_configurations <span class="token punctuation">\</span>
<span class="token assign-left variable">service_name</span><span class="token operator">=</span><span class="token string">'cpaneld'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">provider_id</span><span class="token operator">=</span><span class="token string">'cpanelid'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99952a:1" aria-labelledby="tab:R99952a: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:R9p952a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p952a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p952a:0" aria-labelledby="tab:R9p952a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"client_configurations"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"client_id"</span>: <span class="token string">"1234567890"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"client_secret"</span>: <span class="token string">"victoria"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"redirect_uris"</span>: <button class="collapser" aria-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://hostname.example.com:2083/openid_connect_callback/cpanelid">https://hostname.example.com:2083/openid_connect_callback/cpanelid</a><span class="token string">"</span>,</div></li><li><div class="hoverable "><span class="token string">"</span><a href="https://hostname.example.com:2087/openid_connect_callback/cpanelid">https://hostname.example.com:2087/openid_connect_callback/cpanelid</a><span class="token string">"</span>,</div></li><li><div class="hoverable "><span class="token string">"</span><a href="https://hostname.example.com:2096/openid_connect_callback/cpanelid">https://hostname.example.com:2096/openid_connect_callback/cpanelid</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_provider_client_configurations"</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/External-Authentication/operation/get_provider_configuration_fields" data-section-id="tag/External-Authentication/operation/get_provider_configuration_fields" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_provider_configuration_fields" id="operation/get_provider_configuration_fields" 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_provider_configuration_fields" aria-label="tag/External-Authentication/operation/get_provider_configuration_fields"></a>Return identity provider configuration fields<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the configuration fields for a external authentication identity provider.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the configuration fields for a 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_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=cpanelid</span></div><div><div html="<p>The identity provider&#39;s key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The identity provider's key.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="service_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">service_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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpaneld"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"whostmgrd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"webmaild"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service_name=cpaneld</span></div><div><div html="<p>The cPanel &amp; WHM service&#39;s name.</p>
<ul>
<li><code>cpaneld</code></li>
<li><code>whostmgrd</code></li>
<li><code>webmaild</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel & WHM service's name.</p>
<ul>
<li><code>cpaneld</code></li>
<li><code>whostmgrd</code></li>
<li><code>webmaild</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_provider_configuration_fields</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_provider_configuration_fields</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b52a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b52a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b52a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b52a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b52a:0" aria-labelledby="tab:R99b52a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_provider_configuration_fields <span class="token punctuation">\</span>
<span class="token assign-left variable">service_name</span><span class="token operator">=</span><span class="token string">'cpaneld'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">provider_id</span><span class="token operator">=</span><span class="token string">'cpanelid'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b52a:1" aria-labelledby="tab:R99b52a: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:R9pb52a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb52a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb52a:0" aria-labelledby="tab:R9pb52a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"configuration_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">"description"</span>: <span class="token string">"The Secret of the Client"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_order"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"field_id"</span>: <span class="token string">"client_secret"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">"Client Secret"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</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">"description"</span>: <span class="token string">"The ID of the Client."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_order"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"field_id"</span>: <span class="token string">"client_id"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">"Client ID"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token keyword">null</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_provider_configuration_fields"</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/External-Authentication/operation/get_provider_display_configurations" data-section-id="tag/External-Authentication/operation/get_provider_display_configurations" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_provider_display_configurations" id="operation/get_provider_display_configurations" 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_provider_display_configurations" aria-label="tag/External-Authentication/operation/get_provider_display_configurations"></a>Return identity provider login interface appearance<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the display configuration for the login button of an external authentication identity provider.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the display configuration for the login button of 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="last "><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 identity provider&#39;s key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The identity provider's 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_provider_display_configurations</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_provider_display_configurations</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d52a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d52a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d52a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d52a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d52a:0" aria-labelledby="tab:R99d52a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_provider_display_configurations <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>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d52a:1" aria-labelledby="tab:R99d52a: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:R9pd52a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd52a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd52a:0" aria-labelledby="tab:R9pd52a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"configurations"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"dd4b39"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"Google"</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://developers.google.com/identity/protocols/OpenIDConnect">https://developers.google.com/identity/protocols/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">"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4="</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 via Google"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"link"</span>: <span class="token string">"/openid_connect/google"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">"google"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"cpaneld"</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><li><div class="hoverable "><button class="collapser" aria-label="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">"dd4b39"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"Google"</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://developers.google.com/identity/protocols/OpenIDConnect">https://developers.google.com/identity/protocols/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">"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4="</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 via Google"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"link"</span>: <span class="token string">"/openid_connect/google"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">"google"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"webmaild"</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><li><div class="hoverable "><button class="collapser" aria-label="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">"dd4b39"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"Google"</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://developers.google.com/identity/protocols/OpenIDConnect">https://developers.google.com/identity/protocols/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">"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4="</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 via Google"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"link"</span>: <span class="token string">"/openid_connect/google"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">"google"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"whostmgrd"</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></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">"command"</span>: <span class="token string">"get_provider_display_configurations"</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/External-Authentication/operation/set_provider_client_configurations" data-section-id="tag/External-Authentication/operation/set_provider_client_configurations" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_provider_client_configurations" id="operation/set_provider_client_configurations" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/External-Authentication/operation/set_provider_client_configurations" aria-label="tag/External-Authentication/operation/set_provider_client_configurations"></a>Update identity provider client configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the values of configuration fields for an external authentication identity provider.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the values of configuration fields for 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="configurations" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">configurations</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->json<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">configurations={"client_id":"victoria","client_secret":"secret"}</span></div><div><div html="<p>The configuration values to set for the identity provider.</p>
<p><strong>Note</strong></p>
<p>The items in this parameter depend on the fields that the provider implements through OpenID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The configuration values to set for the identity provider.</p>
<p><strong>Note</strong></p>
<p>The items in this parameter depend on the fields that the provider implements through OpenID.</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=cpanelid</span></div><div><div html="<p>The identity provider&#39;s key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The identity provider's key.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="service_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">service_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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpaneld"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"whostmgrd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"webmaild"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service_name=cpaneld</span></div><div><div html="<p>The cPanel &amp; WHM service&#39;s name.</p>
<ul>
<li><code>cpaneld</code> — The cPanel daemon.</li>
<li><code>whostmgrd</code> — The WHM daemon.</li>
<li><code>webmaild</code> — The Webmail daemon.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel & WHM service's name.</p>
<ul>
<li><code>cpaneld</code> — The cPanel daemon.</li>
<li><code>whostmgrd</code> — The WHM daemon.</li>
<li><code>webmaild</code> — The Webmail daemon.</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="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">/set_provider_client_configurations</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_provider_client_configurations</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f52a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f52a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f52a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f52a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f52a:0" aria-labelledby="tab:R99f52a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_provider_client_configurations <span class="token punctuation">\</span>
<span class="token assign-left variable">service_name</span><span class="token operator">=</span><span class="token string">'cpaneld'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">provider_id</span><span class="token operator">=</span><span class="token string">'cpanelid'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">configurations</span><span class="token operator">=</span><span class="token string">'{"client_id":"victoria","client_secret":"secret"}'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f52a:1" aria-labelledby="tab:R99f52a: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:R9pf52a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf52a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf52a:0" aria-labelledby="tab:R9pf52a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_provider_client_configurations"</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/External-Authentication/operation/set_provider_display_configurations" data-section-id="tag/External-Authentication/operation/set_provider_display_configurations" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_provider_display_configurations" id="operation/set_provider_display_configurations" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/External-Authentication/operation/set_provider_display_configurations" aria-label="tag/External-Authentication/operation/set_provider_display_configurations"></a>Update identity provider login interface appearance<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the display configuration for the login button of an external authentication identity provider.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the display configuration for the login button of 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="configurations" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand configurations"><span class="property-name">configurations</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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><div html="<p>The display configuration in JSON-encoded key-value format.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The display configuration in JSON-encoded key-value format.</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=cpanelid</span></div><div><div html="<p>The identity provider&#39;s key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The identity provider's key.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="service_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">service_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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpaneld"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"whostmgrd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"webmaild"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service_name=cpaneld</span></div><div><div html="<p>The cPanel &amp; WHM service&#39;s name.</p>
<ul>
<li><code>cpaneld</code> — The cPanel daemon.</li>
<li><code>whostmgrd</code> — The WHM daemon.</li>
<li><code>webmaild</code> — The Webmail daemon.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel & WHM service's name.</p>
<ul>
<li><code>cpaneld</code> — The cPanel daemon.</li>
<li><code>whostmgrd</code> — The WHM daemon.</li>
<li><code>webmaild</code> — The Webmail daemon.</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="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">/set_provider_display_configurations</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_provider_display_configurations</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99h52a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h52a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h52a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h52a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h52a:0" aria-labelledby="tab:R99h52a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty set_provider_display_configurations <span class="token assign-left variable">service_name</span><span class="token operator">=</span><span class="token string">'cpaneld'</span> <span class="token assign-left variable">provider_id</span><span class="token operator">=</span><span class="token string">'cpanelid'</span> <span class="token assign-left variable">configurations</span><span class="token operator">=</span><span class="token string">'{"color":"dd4b39","display_name":"cPanel","icon":"iVBORw0KGgoAAAANSUhEUgAAACEAAAAhCAYAAABX5MJvAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAV1JREFUeNrsVtGNwjAMJegGYIRucBmhtwEjdAMyQjYoG2SEG6HcBGUDugFskHOQg1zTlFaN\\/\\/KkqMh2yYvt53S3KygomIZaE+y9P8BDJ9xXpdSDxT9jwX7dxDJsDMvCuvl33GF1sBwS5O8GX7eVgCabGyRkGJF25v0sJHrcyDH7iMhWEl9zWSD1\\/xs1klJn8J\\/gZ4WxNdgu8KyiDXGIfmJ7LO6R8CI5rJnwO+Kv0Wb9Z7xlZr+wMt8f\\/ANmyCoCMF3CUmP8rOmHip1AM\\/8tdbLcjfnL5NigYmIp+ilp5iYRJNkmajtLIBuJiUZ1S+aDKGDjI8tGk+N\\/9yuy0ODcGIjL8UEmcXKLDelRDQ5tHcuIkSLQE1WYhIRfMRIEmiV1Z7NES5Rh9nIisRGVWGOyyyflC5fSkDsTmk1KnVBMbForqQw+IVtUCP3KEpdojffHnRGKcq3LZ3pBgST+BRgANXt+WPKE7tYAAAAASUVORK5CYII=","icon_type":"image/svg+xml","label":"Log in with a cPanelID Account","textcolor":"FFFFFF"}'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h52a:1" aria-labelledby="tab:R99h52a: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:R9ph52a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph52a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph52a:0" aria-labelledby="tab:R9ph52a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_provider_display_configurations"</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/External-Authentication/operation/disable_authentication_provider" data-section-id="tag/External-Authentication/operation/disable_authentication_provider" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_authentication_provider" id="operation/disable_authentication_provider" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/External-Authentication/operation/disable_authentication_provider" aria-label="tag/External-Authentication/operation/disable_authentication_provider"></a>Disable identity provider<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function disables a external authentication identity provider for a specified service.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables a external authentication identity provider for a specified 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="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=cpanelid</span></div><div><div html="<p>A valid identity provider&#39;s identification key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A valid identity provider's identification key.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="service_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">service_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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpaneld"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"webmaild"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"whostmgrd"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service_name=cpaneld</span></div><div><div html="<p>The cPanel &amp; WHM service&#39;s name:</p>
<ul>
<li><code>cpaneld</code></li>
<li><code>webmaild</code></li>
<li><code>whostmgrd</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel & WHM service's name:</p>
<ul>
<li><code>cpaneld</code></li>
<li><code>webmaild</code></li>
<li><code>whostmgrd</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="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">/disable_authentication_provider</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/disable_authentication_provider</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99j52a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j52a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j52a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j52a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j52a:0" aria-labelledby="tab:R99j52a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
disable_authentication_provider <span class="token punctuation">\</span>
<span class="token assign-left variable">service_name</span><span class="token operator">=</span><span class="token string">'cpaneld'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">provider_id</span><span class="token operator">=</span><span class="token string">'cpanelid'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j52a:1" aria-labelledby="tab:R99j52a: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:R9pj52a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj52a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj52a:0" aria-labelledby="tab:R9pj52a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"disable_authentication_provider"</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/External-Authentication/operation/get_users_authn_linked_accounts" data-section-id="tag/External-Authentication/operation/get_users_authn_linked_accounts" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_users_authn_linked_accounts" id="operation/get_users_authn_linked_accounts" 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_users_authn_linked_accounts" aria-label="tag/External-Authentication/operation/get_users_authn_linked_accounts"></a>Return accounts linked to identity providers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists all accounts that link to available external authentication identity providers.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all accounts that link to available external authentication identity 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_users_authn_linked_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_users_authn_linked_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:R99l52a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99l52a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99l52a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l52a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99l52a:0" aria-labelledby="tab:R99l52a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_users_authn_linked_accounts
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l52a:1" aria-labelledby="tab:R99l52a: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:R9pl52a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pl52a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pl52a:0" aria-labelledby="tab:R9pl52a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"username_linked_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 "><button class="collapser" aria-label="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">1443124003</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@example.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">"cpanelid"</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 string">"123456789012345678901"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_users_authn_linked_accounts"</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/External-Authentication/operation/link_user_authn_provider" data-section-id="tag/External-Authentication/operation/link_user_authn_provider" class="sc-dntaoT ceciOs"><div data-section-id="operation/link_user_authn_provider" id="operation/link_user_authn_provider" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/External-Authentication/operation/link_user_authn_provider" aria-label="tag/External-Authentication/operation/link_user_authn_provider"></a>Add identity provider to cPanel account<!-- --> </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 account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 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="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">/link_user_authn_provider</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/link_user_authn_provider</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99n52a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99n52a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99n52a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n52a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99n52a:0" aria-labelledby="tab:R99n52a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
link_user_authn_provider <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:R99n52a:1" aria-labelledby="tab:R99n52a: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:R9pn52a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pn52a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pn52a:0" aria-labelledby="tab:R9pn52a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"link_user_authn_provider"</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/Login-URL" data-section-id="tag/Login-URL" 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-URL" aria-label="tag/Login-URL"></a>Login URL</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Authentication / Login URL</p>
"><p>Authentication / Login URL</p>
</div></div></div><div id="tag/Login-URL/operation/get_login_url" data-section-id="tag/Login-URL/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/Login-URL/operation/get_login_url" aria-label="tag/Login-URL/operation/get_login_url"></a>Return cPanel Store or cPanel Market login URL<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the login URL for the cPanel Store or a
cPanel Market provider.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the login URL for the cPanel Store or a
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 Store or cPanel Market provider&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Store or 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>The location to which the cPanel Store or cPanel Market provider
redirects the user&#39;s browser after they log in.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The location to which the cPanel Store or 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R15772a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R15772a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R15772a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R15772a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R15772a:0" aria-labelledby="tab:R15772a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R15772a:1" aria-labelledby="tab:R15772a: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:R17772a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R17772a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R17772a:0" aria-labelledby="tab:R17772a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"payload"</span>: <span class="token string">"</span><a href="https://account.cpanel.net/oauth2/auth/login?client_id=d5eff4a09e29d5b20752674c0ab2c799c428eb23df4db2df10a5c9d96c37472c76013a41e9a0c714e852965ceaed2e8e05e2f738bc27ee562cfb683fbfc75a01&email=&redirect_uri=http%253A%252F%252Fhostname.example.com%252Fredirectionlocation.cgi%253Fstate&response_type=token">https://account.cpanel.net/oauth2/auth/login?client_id=d5eff4a09e29d5b20752674c0ab2c799c428eb23df4db2df10a5c9d96c37472c76013a41e9a0c714e852965ceaed2e8e05e2f738bc27ee562cfb683fbfc75a01&email=&redirect_uri=http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate&response_type=token</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_login_url"</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/SSH-Keys-and-Connections" data-section-id="tag/SSH-Keys-and-Connections" 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-Keys-and-Connections" aria-label="tag/SSH-Keys-and-Connections"></a>SSH Keys and Connections</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Authentication / SSH Keys and Connections</p>
"><p>Authentication / SSH Keys and Connections</p>
</div></div></div><div id="tag/SSH-Keys-and-Connections/operation/accesshash" data-section-id="tag/SSH-Keys-and-Connections/operation/accesshash" class="sc-dntaoT ceciOs"><div data-section-id="operation/accesshash" id="operation/accesshash" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSH-Keys-and-Connections/operation/accesshash" aria-label="tag/SSH-Keys-and-Connections/operation/accesshash"></a>Return cPanel account access hash<!-- --> <span type="warning" class="sc-jtQUzJ jmDXKf"> Deprecated </span></h2><div class="sc-fantwC dGPqXf"><div html="<p>This function regenerates or retrieves a user&#39;s access hash. For more information about access hashes, read our <a href="https://docs.cpanel.net/whm/clusters/remote-access-key/">Remote Access Key</a> documentation.</p>
<p><strong>Warning:</strong></p>
<p>We <strong>deprecated</strong> this function. We <strong>strongly</strong> suggest that you use the WHM API 1 <code>api_token_create</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function regenerates or retrieves a user's access hash. For more information about access hashes, read our <a href="https://docs.cpanel.net/whm/clusters/remote-access-key/">Remote Access Key</a> documentation.</p>
<p><strong>Warning:</strong></p>
<p>We <strong>deprecated</strong> this function. We <strong>strongly</strong> suggest that you use the WHM API 1 <code>api_token_create</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="generate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">generate</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">generate=0</span></div><div><div html="<p>Whether to regenerate the access hash.</p>
<ul>
<li><code>1</code> — Regenerate the access hash.</li>
<li><code>0</code> — Do <strong>not</strong> regenerate the access hash.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to regenerate the access hash.</p>
<ul>
<li><code>1</code> — Regenerate the access hash.</li>
<li><code>0</code> — Do <strong>not</strong> regenerate the access hash.</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"> <!-- --><<!-- -->username<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=root</span></div><div><div html="<p>The user&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/accesshash</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/accesshash</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99392a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99392a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99392a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99392a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99392a:0" aria-labelledby="tab:R99392a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
accesshash <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'root'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">generate</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:R99392a:1" aria-labelledby="tab:R99392a: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:R9p392a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p392a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p392a:0" aria-labelledby="tab:R9p392a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"accesshash"</span>: <span class="token string">"cb523f89e9a31123fde7c6f93b580ac05bf00a2804d4febe6667ab9917a14baa1c4914da209bf55c862999ea51983a117a4d2f238140200b1e5b270b94b2c52492747e5ebfdeddb8abf4e1b0c428c6c68b701b48e13dbe39da49450e7a8e5422e18ab3b6290b5b6556bd82ee21d9c1103e7a51d1e94f2ac0c4dcc6a10954b8634c6db16a541660c3c89e10254f05583f4167adfcff7781090ea930647b46e5b981f3e16c7723ca4e12dc4b54a778dc66a28df73632a0d3a8e01e207b9fd6b555b72936a903af014f30061d712d736176a87fb5333c5b90cf0bb4f3c6735f2b45929ac79fb1184045a5f4c20bfcc553f5ab760eec077c0d6096e54d02724201281e441e7b0f642370a63f61c68766e224c8510bc32b0316780660c34352cbfeeccfee9d4f02e20ba7b664d3e84e9419ca386c41df07613f8af252aba8626a8b54796bbe616f41af1e6f11a3d0327f7608d23666fca64e6ebe899f7479a5fb0aea008b1e7a41890c9c58037682450febf91b7aa1c080d31d834b0ae466f8533df838ab271b26a7fb7de96402ad4a818d6b786af92c38414d2ef6c88deb7c685a1e60c3cbcfbf20cf6d2a00dd50d2be9bc1824d91284ec6842dd7db42564dfc3ecb75c1a9bc775c45c5f08784b9e2885c2d"</span></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">"command"</span>: <span class="token string">"accesshash"</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/SSH-Keys-and-Connections/operation/authorizesshkey" data-section-id="tag/SSH-Keys-and-Connections/operation/authorizesshkey" class="sc-dntaoT ceciOs"><div data-section-id="operation/authorizesshkey" id="operation/authorizesshkey" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSH-Keys-and-Connections/operation/authorizesshkey" aria-label="tag/SSH-Keys-and-Connections/operation/authorizesshkey"></a>Enable SSH key for server<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function authorizes a public SSH key to access the server.
When you call this function, it adds the key to the <code>/root/.ssh/authorized_keys</code> file.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>Do <strong>not</strong> transfer private keys over insecure ports.</li>
<li>Only <code>root</code> and <code>root</code>-enabled resellers can use this function, and it only affects
the <code>root</code> public SSH keys. To perform this function on a regular user account, call
the cPanel API 2 <code>SSH::authkey</code> function via the WHM API. For more information, read our
<a href="https://go.cpanel.net/UseWHMAPItoCallcPanelAPIandUAPI">Use WHM API to Call cPanel API and UAPI</a>
documentation.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function authorizes a public SSH key to access the server.
When you call this function, it adds the key to the <code>/root/.ssh/authorized_keys</code> file.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>Do <strong>not</strong> transfer private keys over insecure ports.</li>
<li>Only <code>root</code> and <code>root</code>-enabled resellers can use this function, and it only affects
the <code>root</code> public SSH keys. To perform this function on a regular user account, call
the cPanel API 2 <code>SSH::authkey</code> function via the WHM API. For more information, read our
<a href="https://go.cpanel.net/UseWHMAPItoCallcPanelAPIandUAPI">Use WHM API to Call cPanel API and UAPI</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=""><td kind="field" title="authorize" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">authorize</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">authorize=1</span></div><div><div html="<p>Whether to authorize the public SSH key to access the server.</p>
<ul>
<li><code>1</code> — Authorize.</li>
<li><code>0</code> — Do <strong>not</strong> authorize.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to authorize the public SSH key to access the server.</p>
<ul>
<li><code>1</code> — Authorize.</li>
<li><code>0</code> — Do <strong>not</strong> authorize.</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=sshkey.pub</span></div><div><div html="<p>The public SSH key file&#39;s name.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This file <strong>must</strong> exist in the <code>/root/.ssh</code> directory.</li>
<li>If you call <strong>both</strong> the <code>file</code> and the <code>text</code> parameters, the function <strong>ignores</strong>
the <code>file</code> parameter.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The public SSH key file's name.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This file <strong>must</strong> exist in the <code>/root/.ssh</code> directory.</li>
<li>If you call <strong>both</strong> the <code>file</code> and the <code>text</code> parameters, the function <strong>ignores</strong>
the <code>file</code> parameter.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="options" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">options</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">options=agent-forwarding,cert-authority</span></div><div><div html="<p>A comma-separated list of options to include with the public SSH key.
For a list of options, read the
<a href="https://man.openbsd.org/sshd.8#AUTHORIZED_KEYS_FILE_FORMAT">OpenBSD manaual</a>.</p>
<p>This parameter defaults to no options.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of options to include with the public SSH key.
For a list of options, read the
<a href="https://man.openbsd.org/sshd.8#AUTHORIZED_KEYS_FILE_FORMAT">OpenBSD manaual</a>.</p>
<p>This parameter defaults to no options.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="text" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">text</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">text=ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCys7JbGhkAZ8E4Pmq8D4EBm1UedKK2oMhs3RVIEFRJX6S86Itw6Qmhds62LNGrxuVL11W6v25+maIiBhXnslyQpd838tHyAC7J/SJojDid8acovX/4xgJQaJHLAh9tLgyQXnNhIxIGJ4nVZ+8OqM2Vb1Cps+E5H17ivG07PXnVPEvwMaeWkm2DnGgSy5kmjVpNKlj9GWFCn/SJd7up7QnbGKoz87pxKDs3esp+ziuPEAJHLeXnKHWPVukQgtRUpUBdqkCvu5hUkhpaiWmBR8yxajkxbSObPw+ZkELhmm+fQseOfEbrwToMRJCO7gAKwBtNi7OhyFM7YFrvdo0xh6cn</span></div><div><div html="<p>The text of the SSH public key file.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you call <strong>both</strong> the <code>file</code> and the <code>text</code> parameters, the function <strong>ignores</strong>
the <code>file</code> parameter.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The text of the SSH public key file.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you call <strong>both</strong> the <code>file</code> and the <code>text</code> parameters, the function <strong>ignores</strong>
the <code>file</code> parameter.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/authorizesshkey</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/authorizesshkey</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99592a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99592a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99592a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99592a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99592a:0" aria-labelledby="tab:R99592a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
authorizesshkey <span class="token punctuation">\</span>
<span class="token assign-left variable">file</span><span class="token operator">=</span><span class="token string">'sshkey.pub'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">text</span><span class="token operator">=</span><span class="token string">'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCys7JbGhkAZ8E4Pmq8D4EBm1UedKK2oMhs3RVIEFRJX6S86Itw6Qmhds62LNGrxuVL11W6v25+maIiBhXnslyQpd838tHyAC7J/SJojDid8acovX/4xgJQaJHLAh9tLgyQXnNhIxIGJ4nVZ+8OqM2Vb1Cps+E5H17ivG07PXnVPEvwMaeWkm2DnGgSy5kmjVpNKlj9GWFCn/SJd7up7QnbGKoz87pxKDs3esp+ziuPEAJHLeXnKHWPVukQgtRUpUBdqkCvu5hUkhpaiWmBR8yxajkxbSObPw+ZkELhmm+fQseOfEbrwToMRJCO7gAKwBtNi7OhyFM7YFrvdo0xh6cn'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">authorize</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:R99592a:1" aria-labelledby="tab:R99592a: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:R9p592a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p592a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p592a:0" aria-labelledby="tab:R9p592a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"authorized"</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">"sshkey.pub"</span></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">"command"</span>: <span class="token string">"authorizesshkey"</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/SSH-Keys-and-Connections/operation/generatesshkeypair" data-section-id="tag/SSH-Keys-and-Connections/operation/generatesshkeypair" class="sc-dntaoT ceciOs"><div data-section-id="operation/generatesshkeypair" id="operation/generatesshkeypair" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSH-Keys-and-Connections/operation/generatesshkeypair" aria-label="tag/SSH-Keys-and-Connections/operation/generatesshkeypair"></a>Create SSH key pair<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function generates an SSH key pair.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function generates an SSH 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=""><td kind="field" title="abort_on_existing_key" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">abort_on_existing_key</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">abort_on_existing_key=1</span></div><div><div html="<p>Whether to abort the function if the user already has a key with the same name.</p>
<ul>
<li><code>1</code> — Abort.</li>
<li><code>0</code> — Continue.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to abort the function if the user already has a key with the same name.</p>
<ul>
<li><code>1</code> — Abort.</li>
<li><code>0</code> — Continue.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="algorithm" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">algorithm</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"rsa2"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"dsa"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">algorithm=dsa</span></div><div><div html="<p>The key&#39;s encryption algorithm. The parameter defaults to the system&#39;s default algorithm.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key's encryption algorithm. The parameter defaults to the system's default algorithm.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="bits" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">bits</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">1024</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">2048</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">bits=2048</span></div><div><div html="<p>The key&#39;s bits:</p>
<ul>
<li><code>1024</code> — The DSA algorithm&#39;s default value.</li>
<li><code>2048</code></li>
<li><code>4096</code> — The RSA algorithm&#39;s default value.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key's bits:</p>
<ul>
<li><code>1024</code> — The DSA algorithm's default value.</li>
<li><code>2048</code></li>
<li><code>4096</code> — The RSA algorithm's default value.</li>
</ul>
</div></div></div></td></tr><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">""</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">comment=NoComment</span></div><div><div html="<p>A comment.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comment.</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"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"id_rsa"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=KeyFile</span></div><div><div html="<p>The key&#39;s filename.</p>
<p>This parameter defaults to <code>id_rsa</code> if the algorithm is RSA, and <code>id_dsa</code>
if the algorithm is DSA.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key's filename.</p>
<p>This parameter defaults to <code>id_rsa</code> if the algorithm is RSA, and <code>id_dsa</code>
if the algorithm is DSA.</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"> <!-- -->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">passphrase=123456luggage</span></div><div><div html="<p>The key&#39;s secure passphrase.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key's secure passphrase.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/generatesshkeypair</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/generatesshkeypair</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99792a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99792a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99792a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99792a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99792a:0" aria-labelledby="tab:R99792a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
generatesshkeypair
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99792a:1" aria-labelledby="tab:R99792a: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:R9p792a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p792a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p792a:0" aria-labelledby="tab:R9p792a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fingerprint"</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">"KeyFile"</span></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">"command"</span>: <span class="token string">"generatesshkeypair"</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/SSH-Keys-and-Connections/operation/check_remote_ssh_connection" data-section-id="tag/SSH-Keys-and-Connections/operation/check_remote_ssh_connection" class="sc-dntaoT ceciOs"><div data-section-id="operation/check_remote_ssh_connection" id="operation/check_remote_ssh_connection" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSH-Keys-and-Connections/operation/check_remote_ssh_connection" aria-label="tag/SSH-Keys-and-Connections/operation/check_remote_ssh_connection"></a>Validate SSH connection to another server<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function tests an SSH connection to another server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function tests an SSH connection to another 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="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><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">host=example.com</span></div><div><div html="<p>The remote server&#39;s hostname.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server's hostname.</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=22</span></div><div><div html="<p>The remote server&#39;s port number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server's port 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/check_remote_ssh_connection</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/check_remote_ssh_connection</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99992a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99992a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99992a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99992a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99992a:0" aria-labelledby="tab:R99992a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
check_remote_ssh_connection <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:R99992a:1" aria-labelledby="tab:R99992a: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:R9p992a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p992a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p992a:0" aria-labelledby="tab:R9p992a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"comment"</span>: <span class="token string">"null"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"protocol_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">"2.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">"received"</span>: <span class="token string">"SSH-2.0-OpenSSH_5.3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server_software"</span>: <span class="token string">"OpenSSH_5.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">"metadata"</span>: <button class="collapser" aria-label="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">"check_remote_ssh_connection"</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/SSH-Keys-and-Connections/operation/convertopensshtoputty" data-section-id="tag/SSH-Keys-and-Connections/operation/convertopensshtoputty" class="sc-dntaoT ceciOs"><div data-section-id="operation/convertopensshtoputty" id="operation/convertopensshtoputty" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSH-Keys-and-Connections/operation/convertopensshtoputty" aria-label="tag/SSH-Keys-and-Connections/operation/convertopensshtoputty"></a>Migrate OpenSSH key to PuTTY format<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function converts an OpenSSH private key to a PuTTY key.</p>
<p><strong>Warning:</strong></p>
<p>Do <strong>not</strong> transfer private keys over insecure ports.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function converts an OpenSSH private key to a PuTTY key.</p>
<p><strong>Warning:</strong></p>
<p>Do <strong>not</strong> transfer private keys over insecure ports.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><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=KeyFile</span></div><div><div html="<p>The private key file&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The private key file's name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="keep_file" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">keep_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">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">keep_file=0</span></div><div><div html="<p>Whether to keep the OpenSSH file on the server after conversion.</p>
<ul>
<li><code>1</code> — Keep the file.</li>
<li><code>0</code> — Delete the file.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to keep the OpenSSH file on the server after conversion.</p>
<ul>
<li><code>1</code> — Keep the file.</li>
<li><code>0</code> — Delete the file.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">passphrase=12345luggage</span></div><div><div html="<p>The private key file&#39;s passphrase.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The private key file's passphrase.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/convertopensshtoputty</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/convertopensshtoputty</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b92a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b92a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b92a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b92a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b92a:0" aria-labelledby="tab:R99b92a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
convertopensshtoputty <span class="token punctuation">\</span>
<span class="token assign-left variable">file</span><span class="token operator">=</span><span class="token string">'KeyFile'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b92a:1" aria-labelledby="tab:R99b92a: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:R9pb92a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb92a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb92a:0" aria-labelledby="tab:R9pb92a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"PuTTY-User-Key-File-2: ssh-rsa Encryption: aes256-cbc Comment: imported-openssh-key Public-Lines: 12 AAAAB3NzaC1yc2EAAAABIwAAAgEAuuth41YYyWABsRKexJXgSMD8FvIBFCptUfZP 4U/6R41FvL/RS+99kq1WL/KASsKRoEA5uc0axM+iNgZtKuemQYGUZNvN+8X8sC/l E6GF7X3Pvj2Ml4AlD7TQv0WQZUp9xn+SlOti+3pYh+S56vzNjvdifO7U5mPGW/81 9N4vGhG3ThaAgETwkL33CM2LeNRuvoWpeQcuzEVX2aOvHQZqOvV15fTjZ64ZGL3i UDtKmeaHs4tMqgNIUXgn1P1V4TgPvTIfopH8FBX3g1pD15XD3vn+XHLwia0505c5 +QM+jElS3HHb0vrrDo3S+8koXLWp07wu/GYrvBd5+MlsSV7bpr7lmWj8uMQjc0ap eZe+eb/MteadWnqIPeOVuracssCvDLqXEPK2KjhFMPqBTepNhZaJHRfvkodPm43C 50nhqzrNoxFvXb1rfCjPPqGfhuSZhlCmo2FDiZPKdl0X7bhzDIvMVikyqJP06bqK y9iclyQv0VPfyCIx/VDcVclIoUa8A49nAinXHKeUx9QUNBHv8wXdyz7W41jQa+++ Ih3Yc4o9rpV95DDmKp7iF6kFk4aVjIWDgEsPTaL28wlvUyazoW5TAGPHDrRJoedU ag8KDRNPrGbKYu3CvoINiz0sshyCvr1gjKNG75Cwe+L4hXIkaw8wlCpwFq8VSX70 RS9Pei8= Private-Lines: 28 bb31s+xsiAv1+pclnmvreEYdxvuVmbeWMjUWJd4Y4TKIAyLEItsXNs078qn1QAZ+ Wj6t+0HcnhuUVICHyCyJrp++1g4OtzTAHRczaD5ybhb9ktSe1qlnszKD1Rg5/o+B 61h6kvMcZyuNSjtPkmqQ3XIh8OFYybB2oJXY7gJQzfRuRwk8dx9YWtIR4438Nbv5 ecTzGUDWvx+AfYzC4X/UIGiRy8AftfiBQyA+c1OFyg37qM1SLYnZYmIpSf5GsQ3A MaEGlB9P9hE2uoqZ4yT/A0aHj7w8DGEzYZqxNbMlCIJhLEO3vKZvMvaq7Q8ramG6 BzYwUz+8NPgCBUp1qyIcN2vvEHEq57pMMHYNfJMVfG9o0ijo+xxGCPV3MosmmvRI 1nxH0nrgdA2o6SJp/dJrKm3Hicbbxak/Kz4m8BROcnlCgptdjHp9V/cBnFq/UUHv or32gShGWmnG6+XyQs4LxpbLC4koz8EjPwg3/3W2Qn6Drn3i98omvZpmnX466i7e GUiHaiKTpBkqZkHmHFxNBAbbs85yngeo8o3RGUsmN69RupTqSkkLDuDFOMwgfsZG TWexWg/qBe+8Xrbshd9HphxvWv+Q3YcSeg+mm8Bc50Q5saLKYdQQsbfV5wtIpvLj 0eyjoTSh+FkPGBw/iB1MDzYV5OoIIgiDBndP2bOK2zFsLElSbbv/r3i//wL98316DgJWmJiQDqKxly4MEij8TfIVDAsdeyJJKvg6iGahonHbEBkZ9g9wcCpxlg8iMtTf /7eb8SmcPwe1NGdgB7PR1dU/RQ/kBbLaaBfo/1jQEnCC8VmksVu7B9ULImfLEOEm +A4J4NpKKlQocgCvJAtMogL+uRS5GpojJIElVqP12jnb7Ij3AYY3Zb4qotlprLeK 7dJslpNnrD/MSvbJZ/ZoAX+xyDxUMeq/83Xv30i5/wh00QBY4Cv5NTDU4rPoVmQm EWGW5aQx34in4JHY5bK3F4BvVYm7MscKLHoU8/OeKVAgzNcatUgPlN43FG9SX0AE pP3EYlVADSfULdbfBn9dZDidAiDMXnCv9259J65zA64tuT9XluinHXVs5PA/f5vm rZPQhAzGThw7h9L6rGYGfSKd9KYoTwf8kSOA6WU7OEyhfTvCdaW76vPi4CRW2M/Y RHX0IUdv3VxfKb4WnXFeQl6LshmGB1T2mbMyfThlqUCGAvPJyWDtZ6OpOUl3CK87 3jhFzO7t5wruhuWZ3RcISVsrdqcjgCrKy6Q9y+HbLJoNY40BkJm7f6WeV+hHn7o1 od7JiqDGq3Qk+ECEdexvqdRQS7BWgO7xudGFk+WFY02zoGvq5DMviNfsxqhM06P+ JgEinB8xPPCOPzi6q8T1y1Pz44gmluM15/QRX4z0Mwz6UQasVC/NsZxdfoNGtCy0 c2DAscy4zsiKhZMlLr0loPYycO2bOit6E5eYkrACJR2115/ZgVwzvzdmc/INJCxG3TvKYbeuv/tkolt56uJWGfMF2ZrfLJaaQ0iAiUyMep/keLP2bJ4Y97o+03BtQszZ zixXvzeQAX97WdBaUJU0C3mCKDOtkv4RWZ8hXV5v0m2tm7xbXVBzF22Pej2iHDKx GQkciskBRwQM4bDZorkcO+WnGn6uPbtw5v/AuIUqB1UNAcehWN6UTiFNveP4hLYu iRGWnZZ+uTbip91PNXSxXzb9yMWV2qSVIsZvud8kpR8ttL26Z4ySUKkFuPrgUeTeELnOF3GP6Ixk+IkwxU575w== Private-MAC: 1dfa6a4c8297d31e4cfadbf61aac8b4c5ca75584"</span></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">"command"</span>: <span class="token string">"convertopensshtoputty"</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/SSH-Keys-and-Connections/operation/importsshkey" data-section-id="tag/SSH-Keys-and-Connections/operation/importsshkey" class="sc-dntaoT ceciOs"><div data-section-id="operation/importsshkey" id="operation/importsshkey" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSH-Keys-and-Connections/operation/importsshkey" aria-label="tag/SSH-Keys-and-Connections/operation/importsshkey"></a>Import SSH key<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function imports an SSH key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function imports an SSH 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="extract_private" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">extract_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"> <!-- -->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">extract_private=0</span></div><div><div html="<p>Whether to extract and save only the private key.</p>
<ul>
<li><code>1</code> — Private key only.</li>
<li><code>0</code> — All data.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter defaults to <code>1</code> for
PPK <a href="https://www.puttygen.com/">(PuTTY Key Generator)</a>
files and <code>0</code> for all other imports.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to extract and save only the private key.</p>
<ul>
<li><code>1</code> — Private key only.</li>
<li><code>0</code> — All data.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter defaults to <code>1</code> for
PPK <a href="https://www.puttygen.com/">(PuTTY Key Generator)</a>
files and <code>0</code> for all other imports.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="extract_public" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">extract_public</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">extract_public=0</span></div><div><div html="<p>Whether to extract and save only the public key.</p>
<ul>
<li><code>1</code> — Public key only.</li>
<li><code>0</code> — All data.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter defaults to <code>1</code> for
PPK <a href="https://www.puttygen.com/">(PuTTY Key Generator)</a>
files and <code>0</code> for all other imports.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to extract and save only the public key.</p>
<ul>
<li><code>1</code> — Public key only.</li>
<li><code>0</code> — All data.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter defaults to <code>1</code> for
PPK <a href="https://www.puttygen.com/">(PuTTY Key Generator)</a>
files and <code>0</code> for all other imports.</p>
</div></div></div></td></tr><tr class=""><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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=-----BEGIN RSA PRIVATE KEY----- hPH+o4NgZrky7iGBb5iUg8R4aQzLPexpYfet25bLESvHOtutsBkbN7UWAaoM0pgM hytunlM8UU4BArJWlJyY6AD59aluZowBbuowKeU+f+TRaeJNJvkxTCOAipzp6LyG nrSVJ5hxSN/RPfntho1MEsdWYewVI4eLayuiZJyD+VONCYJh/vPLaZ9AVUJuMerl s/ZJ24AwCW8cILG+C3TWJRCjl4Ji+sJ9A5P29p/ad18cyJc1F+wmAzMULWitCaB7 mmE0i1nkiZRygQzzKjqdBYWCjujxfoE2+nPufAJg8ZdIEI1xSVBe5jKnj8DRX67w NAnNjXANMRePo39/RbDOSEXsD62h1qH93SnPsAhYT1JE6xHKV85AVIVOe8ktTA8t jMBBioCudBFngqPHknUrIJZ2QfUm0fkKBZaoKW4yr3JjGk+5y6kg02gSDIA7/jGc 8rs3iKN+QJ/ug2x/v7Xe0OozVqpl5QTltEMGJzJ1jFh9WnqgsgLTiJWlE7x5VSv8 fV8A5WTafOhBHnKuOpmpjAel1GD5DT1jNx3LhWXMHOayawC0WY04lT5kkLLWhuN2 pNqY6UBk6Z3m1ifPINq85RdnHriJiD3H/+6P+cUyGSOznni8yqU764LId4nNClWd Xc+VvM1Udw0Sm7xF7err9CKHYUg3HfFYQPBQOfI0ib9wqOi7zWq2vhH21B5OgcTg Bsw/HJUQ/IVnTbsqgZSn0sckaRguv/ifmwbISO1aQ4Yxcohe/4miOw05r6ihbYGW LO5kP0I8SBMCibkGFh5AxVnNgoGAW0l33hOPPSIVUTkE+8d3zYXLzupTFXCvmohl jq0it7uIGOxSglf7XH3eXlNKaZjK7pBJgS5HeXM80JI8FCfifqnkaik8XTE66Ll0 s1ySaGevGkPpX5Rhbgsm4IqddAeFvlmKIND8Zvh/wfT++bbD7bbFwFlrWCU3chce 8KaNVUP+whCAlaS7oGcs38ygaRFXIE3vug4Ra8Xiy/qfyp4YR67sMg46avHyoVky uFbVv2n7HphZb7g3WS3ns3/gCQQv9TYcdBoRnKW2yEqbzOQb9Fdt7EjgMohT/bdS pM6nRWFNdmWoihLzLbSi3bnc9iDwXZA8KyE3mpVi4QFfijR4dfrVWxEz5Ln2l9HC SZA6VPGzEOwOVVND98/HTu3oViJUV1gyDIWlyggSUDTyhfo/Z+c3tTHa+cv0f7xY oL63hWLgZQD2m/g6rKpsN3NhC77tCyCNZavdKy7usvZyCsoH/mPR2129LcwAwbJ3 u2Ec7qLncztSePHOmfmCTTED00a0YzFhKIQoJf7GrgLCMapYN/YPu0vgTDMPSi11 RH0rdyzd6MuPVDZwLnWO+SltjX85yz1ba/Q199HZwQOw6ZyejDaPSWJHOndD3k+r Q0T38gci9k4D87EwmfpK7zOaCoaiGiRQ6+DdYOv6hlzQ6Fdb2FOtlGQZharQ9WTC jOJBEj2oGUruc6P3fqhfUVllWi4cck0GgWZwcsmG1dDr8W6K9lrGA1dPbXoOns1B l58ghMGtHG7D0VlHs6SIqFmHr5kUgSQ4jJ2KZkVU8CrPBZ2HRtHQJJyjZWW2AbrE -----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><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=TestKey</span></div><div><div html="<p>The key&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key's name.</p>
</div></div></div></td></tr><tr class=""><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 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">passphrase=123456luggage</span></div><div><div html="<p>The key&#39;s passphrase.</p>
<p><strong>Note:</strong></p>
<p>This parameter is <strong>required</strong> whenever you import a PPK file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key's passphrase.</p>
<p><strong>Note:</strong></p>
<p>This parameter is <strong>required</strong> whenever you import a PPK file.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-ovuCP sc-eauhAA dEkioI iQpMVv deprecated" kind="field" title="user"><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 type="warning" class="sc-jtQUzJ jmDXKf"> <!-- -->Deprecated<!-- --> </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 key&#39;s owner.</p>
<p><strong>Note:</strong></p>
<p>You can specify this parameter, but the system does <strong>not</strong> use it.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key's owner.</p>
<p><strong>Note:</strong></p>
<p>You can specify this parameter, but the system does <strong>not</strong> use it.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/importsshkey</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/importsshkey</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d92a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d92a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d92a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d92a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d92a:0" aria-labelledby="tab:R99d92a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
importsshkey <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'TestKey'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">key</span><span class="token operator">=</span><span class="token string">'-----BEGIN RSA PRIVATE KEY----- hPH+o4NgZrky7iGBb5iUg8R4aQzLPexpYfet25bLESvHOtutsBkbN7UWAaoM0pgM hytunlM8UU4BArJWlJyY6AD59aluZowBbuowKeU+f+TRaeJNJvkxTCOAipzp6LyG nrSVJ5hxSN/RPfntho1MEsdWYewVI4eLayuiZJyD+VONCYJh/vPLaZ9AVUJuMerl s/ZJ24AwCW8cILG+C3TWJRCjl4Ji+sJ9A5P29p/ad18cyJc1F+wmAzMULWitCaB7 mmE0i1nkiZRygQzzKjqdBYWCjujxfoE2+nPufAJg8ZdIEI1xSVBe5jKnj8DRX67w NAnNjXANMRePo39/RbDOSEXsD62h1qH93SnPsAhYT1JE6xHKV85AVIVOe8ktTA8t jMBBioCudBFngqPHknUrIJZ2QfUm0fkKBZaoKW4yr3JjGk+5y6kg02gSDIA7/jGc 8rs3iKN+QJ/ug2x/v7Xe0OozVqpl5QTltEMGJzJ1jFh9WnqgsgLTiJWlE7x5VSv8 fV8A5WTafOhBHnKuOpmpjAel1GD5DT1jNx3LhWXMHOayawC0WY04lT5kkLLWhuN2 pNqY6UBk6Z3m1ifPINq85RdnHriJiD3H/+6P+cUyGSOznni8yqU764LId4nNClWd Xc+VvM1Udw0Sm7xF7err9CKHYUg3HfFYQPBQOfI0ib9wqOi7zWq2vhH21B5OgcTg Bsw/HJUQ/IVnTbsqgZSn0sckaRguv/ifmwbISO1aQ4Yxcohe/4miOw05r6ihbYGW LO5kP0I8SBMCibkGFh5AxVnNgoGAW0l33hOPPSIVUTkE+8d3zYXLzupTFXCvmohl jq0it7uIGOxSglf7XH3eXlNKaZjK7pBJgS5HeXM80JI8FCfifqnkaik8XTE66Ll0 s1ySaGevGkPpX5Rhbgsm4IqddAeFvlmKIND8Zvh/wfT++bbD7bbFwFlrWCU3chce 8KaNVUP+whCAlaS7oGcs38ygaRFXIE3vug4Ra8Xiy/qfyp4YR67sMg46avHyoVky uFbVv2n7HphZb7g3WS3ns3/gCQQv9TYcdBoRnKW2yEqbzOQb9Fdt7EjgMohT/bdS pM6nRWFNdmWoihLzLbSi3bnc9iDwXZA8KyE3mpVi4QFfijR4dfrVWxEz5Ln2l9HC SZA6VPGzEOwOVVND98/HTu3oViJUV1gyDIWlyggSUDTyhfo/Z+c3tTHa+cv0f7xY oL63hWLgZQD2m/g6rKpsN3NhC77tCyCNZavdKy7usvZyCsoH/mPR2129LcwAwbJ3 u2Ec7qLncztSePHOmfmCTTED00a0YzFhKIQoJf7GrgLCMapYN/YPu0vgTDMPSi11 RH0rdyzd6MuPVDZwLnWO+SltjX85yz1ba/Q199HZwQOw6ZyejDaPSWJHOndD3k+r Q0T38gci9k4D87EwmfpK7zOaCoaiGiRQ6+DdYOv6hlzQ6Fdb2FOtlGQZharQ9WTC jOJBEj2oGUruc6P3fqhfUVllWi4cck0GgWZwcsmG1dDr8W6K9lrGA1dPbXoOns1B l58ghMGtHG7D0VlHs6SIqFmHr5kUgSQ4jJ2KZkVU8CrPBZ2HRtHQJJyjZWW2AbrE -----END RSA PRIVATE KEY-----'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d92a:1" aria-labelledby="tab:R99d92a: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:R9pd92a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd92a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd92a:0" aria-labelledby="tab:R9pd92a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"importsshkey"</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/SSH-Keys-and-Connections/operation/listsshkeys" data-section-id="tag/SSH-Keys-and-Connections/operation/listsshkeys" class="sc-dntaoT ceciOs"><div data-section-id="operation/listsshkeys" id="operation/listsshkeys" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSH-Keys-and-Connections/operation/listsshkeys" aria-label="tag/SSH-Keys-and-Connections/operation/listsshkeys"></a>Return SSH keys list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the server&#39;s SSH keys.</p>
<p><strong>Warning:</strong></p>
<p>Only the <code>root</code> account can use this function, and it only affects the <code>root</code>
keys. To perform this function on a regular user account, call the cPanel API
2 <code>SSH::listkeys</code> function through the WHM API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the server's SSH keys.</p>
<p><strong>Warning:</strong></p>
<p>Only the <code>root</code> account can use this function, and it only affects the <code>root</code>
keys. To perform this function on a regular user account, call the cPanel API
2 <code>SSH::listkeys</code> function through the WHM API.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="files" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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">files=TestKey</span></div><div><div html="<p>A filename, to limit the results to keys that have that filename.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A filename, to limit the results to keys that have that filename.</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">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">private=0</span></div><div><div html="<p>Whether to display only private keys.</p>
<ul>
<li><code>1</code> — Display only private keys.</li>
<li><code>0</code> — Display all keys.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to display only private keys.</p>
<ul>
<li><code>1</code> — Display only private keys.</li>
<li><code>0</code> — Display all keys.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="private_texts" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">private_texts</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">private_texts=0</span></div><div><div html="<p>Whether to include private key text.</p>
<ul>
<li><code>1</code> — Include private key text.</li>
<li><code>0</code> — Do <strong>not</strong> include private key text.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to include private key text.</p>
<ul>
<li><code>1</code> — Include private key text.</li>
<li><code>0</code> — Do <strong>not</strong> include private key text.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="public" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">public</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">public=0</span></div><div><div html="<p>Whether to display only public keys.</p>
<ul>
<li><code>1</code> — Display only public keys.</li>
<li><code>0</code> — Display all keys.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to display only public keys.</p>
<ul>
<li><code>1</code> — Display only public keys.</li>
<li><code>0</code> — Display all keys.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="public_texts" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">public_texts</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">public_texts=0</span></div><div><div html="<p>Whether to include public key text.</p>
<ul>
<li><code>1</code> — Include public key text.</li>
<li><code>0</code> — Do <strong>not</strong> include public key text.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to include public key text.</p>
<ul>
<li><code>1</code> — Include public key text.</li>
<li><code>0</code> — Do <strong>not</strong> include public key text.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="sync_authorized" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">sync_authorized</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">sync_authorized=0</span></div><div><div html="<p>Whether to synchronize the keys that can access the server.</p>
<ul>
<li><code>1</code> — Synchronize the keys.</li>
<li><code>0</code> — Do <strong>not</strong> synchronize the keys.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to synchronize the keys that can access the server.</p>
<ul>
<li><code>1</code> — Synchronize the keys.</li>
<li><code>0</code> — Do <strong>not</strong> synchronize the keys.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/listsshkeys</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/listsshkeys</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f92a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f92a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f92a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f92a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f92a:0" aria-labelledby="tab:R99f92a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
listsshkeys
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f92a:1" aria-labelledby="tab:R99f92a: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:R9pf92a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf92a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf92a:0" aria-labelledby="tab:R9pf92a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"authorized"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"comment"</span>: <span class="token string">"REPO username@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ctime"</span>: <span class="token number">1416596824</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">"TestKey"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mtime"</span>: <span class="token number">1416596824</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">"ssh-rsaXXXXX3XXXX1XX2XXXXXXXXXXXXXXxXXXX6XXXXX90X41X7XXXXX02XXXXX8XXXX54XXXXXXXXXXX2X07XXXXXXXXXXX7XXXX4XXX2X98XXXX98X80XXXXXXX7X/X4XXXXxX1XXXXXXXXXXXxXXXXXXXXX6+4XXXX36XXXXX3XXXXXX1XXXXXXX/X7+XX1XX6XXXX0XXXXXXX0XXXXXXXX+XxX99X7X2XXXXXX03xXXXXX0XXXXXXXXXX9XXXXXXX9XXXXXXXXXXXX/XXXXX07XXXXX3XXXXXX5XXX+/XXXXXXXXXXXXX3XxXXXXXXXXXXXX6XXXXXXXXXXXX2XXXXXXXXXXXXXXXXX3XX+XXXX3XXXXXXX== REPO username@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">"metadata"</span>: <button class="collapser" aria-label="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">"listsshkeys"</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/SSH-Keys-and-Connections/operation/deletesshkey" data-section-id="tag/SSH-Keys-and-Connections/operation/deletesshkey" class="sc-dntaoT ceciOs"><div data-section-id="operation/deletesshkey" id="operation/deletesshkey" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSH-Keys-and-Connections/operation/deletesshkey" aria-label="tag/SSH-Keys-and-Connections/operation/deletesshkey"></a>Delete SSH key<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function function deletes an SSH key from the server.</p>
<p><strong>Warning:</strong></p>
<p>Only the <code>root</code> account can use this function, and it only affects
the <code>root</code> keys. To perform this function on a cPanel user account, call the
cPanel API 2 <code>SSH::authkey</code> function through the WHM API.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function function deletes an SSH key from the server.</p>
<p><strong>Warning:</strong></p>
<p>Only the <code>root</code> account can use this function, and it only affects
the <code>root</code> keys. To perform this function on a cPanel user account, call the
cPanel API 2 <code>SSH::authkey</code> function through the WHM API.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><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=/root/.ssh/test</span></div><div><div html="<p>The SSH key file&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH key file's name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="leave_authorized" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">leave_authorized</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">leave_authorized=0</span></div><div><div html="<p>Whether to authorize the SSH key to access the server.</p>
<ul>
<li><code>1</code> — Leave authorized.</li>
<li><code>0</code> — Do <strong>not</strong> leave authorized.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to authorize the SSH key to access the server.</p>
<ul>
<li><code>1</code> — Leave authorized.</li>
<li><code>0</code> — Do <strong>not</strong> leave authorized.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td class="sc-ovuCP sc-eauhAA dEkioI iQpMVv deprecated" kind="field" title="user"><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></div><div><span type="warning" class="sc-jtQUzJ jmDXKf"> <!-- -->Deprecated<!-- --> </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 SSH key&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH key'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/deletesshkey</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/deletesshkey</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99h92a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h92a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h92a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h92a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h92a:0" aria-labelledby="tab:R99h92a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
deletesshkey <span class="token punctuation">\</span>
<span class="token assign-left variable">file</span><span class="token operator">=</span><span class="token string">'/root/.ssh/test'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h92a:1" aria-labelledby="tab:R99h92a: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:R9ph92a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph92a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph92a:0" aria-labelledby="tab:R9ph92a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"/root/.ssh/test"</span></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">"command"</span>: <span class="token string">"deletesshkey"</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/Two-Factor-Authentication" data-section-id="tag/Two-Factor-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/Two-Factor-Authentication" aria-label="tag/Two-Factor-Authentication"></a>Two-Factor Authentication</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Authentication / Two-Factor Authentication</p>
"><p>Authentication / Two-Factor Authentication</p>
</div></div></div><div id="tag/Two-Factor-Authentication/operation/twofactorauth_get_tfa_config_for_user" data-section-id="tag/Two-Factor-Authentication/operation/twofactorauth_get_tfa_config_for_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/twofactorauth_get_tfa_config_for_user" id="operation/twofactorauth_get_tfa_config_for_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Authentication/operation/twofactorauth_get_tfa_config_for_user" aria-label="tag/Two-Factor-Authentication/operation/twofactorauth_get_tfa_config_for_user"></a>Return cPanel account 2FA data<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the Two-Factor Authentication (2FA) configuration for a cPanel account, its email accounts, and its team user accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the Two-Factor Authentication (2FA) configuration for a cPanel account, its email accounts, and its team user 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="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=example</span></div><div><div html="<p>The username for the account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><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 cPanel user account that the API was called for.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel user account that the API was called for.</p>
</div></div></div></td></tr><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">/twofactorauth_get_tfa_config_for_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/twofactorauth_get_tfa_config_for_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:R993b2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R993b2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R993b2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R993b2a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R993b2a:0" aria-labelledby="tab:R993b2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
twofactorauth_get_tfa_config_for_user <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:R993b2a:1" aria-labelledby="tab:R993b2a: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:R9p3b2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p3b2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p3b2a:0" aria-labelledby="tab:R9p3b2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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"</span>: <button class="collapser" aria-label="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">"user@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">"secret"</span>: <span class="token string">"QLLIU5WTY3UTJGNG"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"primary_account"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"secret"</span>: <span class="token string">"QLLIU5WTY3UTJGNG"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"team"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_user@example"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"secret"</span>: <span class="token string">"QLLIU5WTY3UTJGNG"</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">"metadata"</span>: <button class="collapser" aria-label="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">"twofactorauth_get_tfa_config_for_user"</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/Two-Factor-Authentication/operation/twofactorauth_set_tfa_config_for_user" data-section-id="tag/Two-Factor-Authentication/operation/twofactorauth_set_tfa_config_for_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/twofactorauth_set_tfa_config_for_user" id="operation/twofactorauth_set_tfa_config_for_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Authentication/operation/twofactorauth_set_tfa_config_for_user" aria-label="tag/Two-Factor-Authentication/operation/twofactorauth_set_tfa_config_for_user"></a>Update cPanel account's 2FA data<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function updates the Two-Factor Authentication (2FA) configuration for the given cPanel user.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates the Two-Factor Authentication (2FA) configuration for the given cPanel 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><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="additionalProperties" title="property name*" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand property name*"><span class="property-name">property 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 sc-iRLAEC hPAOR feFoaC jmhcYd">additional property</div></td><td class="sc-fFoeYl dYBdBR"><div><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 cPanel user account for which to set the 2FA config.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel user account for which to set the 2FA config.</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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/twofactorauth_set_tfa_config_for_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/twofactorauth_set_tfa_config_for_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:R995b2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R995b2a:0" tabindex="0" data-rttab="true">Payload</li><li class="react-tabs__tab" role="tab" id="tab:R995b2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R995b2a:1" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R995b2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R995b2a: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:R995b2a:0" aria-labelledby="tab:R995b2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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"</span>: <button class="collapser" aria-label="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">"user@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">"secret"</span>: <span class="token string">"QLLIU5WTY3UTJGNG"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"primary_account"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"secret"</span>: <span class="token string">"QLLIU5WTY3UTJGNG"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"team"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_user@example"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"secret"</span>: <span class="token string">"QLLIU5WTY3UTJGNG"</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></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R995b2a:1" aria-labelledby="tab:R995b2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R995b2a:2" aria-labelledby="tab:R995b2a: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:R9p5b2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p5b2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p5b2a:0" aria-labelledby="tab:R9p5b2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"twofactorauth_set_tfa_config_for_user"</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/Two-Factor-Authentication/operation/twofactorauth_disable_policy" data-section-id="tag/Two-Factor-Authentication/operation/twofactorauth_disable_policy" class="sc-dntaoT ceciOs"><div data-section-id="operation/twofactorauth_disable_policy" id="operation/twofactorauth_disable_policy" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Authentication/operation/twofactorauth_disable_policy" aria-label="tag/Two-Factor-Authentication/operation/twofactorauth_disable_policy"></a>Disable 2FA<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function disables the Two-Factor Authentication (2FA) security policy on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables the Two-Factor Authentication (2FA) security policy on the 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="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">/twofactorauth_disable_policy</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/twofactorauth_disable_policy</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R997b2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R997b2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R997b2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R997b2a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R997b2a:0" aria-labelledby="tab:R997b2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
twofactorauth_disable_policy
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R997b2a:1" aria-labelledby="tab:R997b2a: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:R9p7b2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p7b2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p7b2a:0" aria-labelledby="tab:R9p7b2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"twofactorauth_disable_policy"</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/Two-Factor-Authentication/operation/twofactorauth_enable_policy" data-section-id="tag/Two-Factor-Authentication/operation/twofactorauth_enable_policy" class="sc-dntaoT ceciOs"><div data-section-id="operation/twofactorauth_enable_policy" id="operation/twofactorauth_enable_policy" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Authentication/operation/twofactorauth_enable_policy" aria-label="tag/Two-Factor-Authentication/operation/twofactorauth_enable_policy"></a>Enable 2FA<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables the Two-Factor Authentication (2FA) security policy on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables the Two-Factor Authentication (2FA) security policy on the 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="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">/twofactorauth_enable_policy</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/twofactorauth_enable_policy</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R999b2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R999b2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R999b2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R999b2a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R999b2a:0" aria-labelledby="tab:R999b2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
twofactorauth_enable_policy
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R999b2a:1" aria-labelledby="tab:R999b2a: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:R9p9b2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p9b2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p9b2a:0" aria-labelledby="tab:R9p9b2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"twofactorauth_enable_policy"</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/Two-Factor-Authentication/operation/twofactorauth_get_issuer" data-section-id="tag/Two-Factor-Authentication/operation/twofactorauth_get_issuer" class="sc-dntaoT ceciOs"><div data-section-id="operation/twofactorauth_get_issuer" id="operation/twofactorauth_get_issuer" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Authentication/operation/twofactorauth_get_issuer" aria-label="tag/Two-Factor-Authentication/operation/twofactorauth_get_issuer"></a>Return configured issuer for current user<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the currently configured issuer. The issuer appears within the authentication app.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the currently configured issuer. The issuer appears within the authentication app.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/twofactorauth_get_issuer</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/twofactorauth_get_issuer</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99bb2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99bb2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99bb2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99bb2a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99bb2a:0" aria-labelledby="tab:R99bb2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
twofactorauth_get_issuer
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99bb2a:1" aria-labelledby="tab:R99bb2a: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:R9pbb2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pbb2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pbb2a:0" aria-labelledby="tab:R9pbb2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"issuer"</span>: <span class="token string">"example.cpanel.net"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"system_wide_issuer"</span>: <span class="token string">"example.cpanel.net"</span></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">"command"</span>: <span class="token string">"twofactorauth_get_issuer"</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/Two-Factor-Authentication/operation/twofactorauth_remove_user_config" data-section-id="tag/Two-Factor-Authentication/operation/twofactorauth_remove_user_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/twofactorauth_remove_user_config" id="operation/twofactorauth_remove_user_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Authentication/operation/twofactorauth_remove_user_config" aria-label="tag/Two-Factor-Authentication/operation/twofactorauth_remove_user_config"></a>Remove 2FA settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes the Two-Factor Authentication (2FA) settings for one or more specified user accounts.</p>
<p><strong>Note:</strong></p>
<p>If you remove the 2FA settings for an account, the user <strong>must</strong> perform the setup procedure again to re-configure 2FA on the account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes the Two-Factor Authentication (2FA) settings for one or more specified user accounts.</p>
<p><strong>Note:</strong></p>
<p>If you remove the 2FA settings for an account, the user <strong>must</strong> perform the setup procedure again to re-configure 2FA 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="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> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=user-1=username1 user-2=username2 user-3=username3</span> -<!-- --> <!-- -->Multiple users.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=example.com</span> -<!-- --> <!-- -->A single user.</li></ul><div><div html="<p>The account&#39;s username.</p>
<p><strong>Note:</strong></p>
<p> To remove multiple users, increment the parameter name. For example, <code>user-1</code>, <code>user-2</code>, or <code>user-3</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's username.</p>
<p><strong>Note:</strong></p>
<p> To remove multiple users, increment the parameter name. For example, <code>user-1</code>, <code>user-2</code>, or <code>user-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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/twofactorauth_remove_user_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/twofactorauth_remove_user_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:R99db2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99db2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99db2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99db2a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99db2a:0" aria-labelledby="tab:R99db2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
twofactorauth_remove_user_config <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R99db2a:1" aria-labelledby="tab:R99db2a: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:R9pdb2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pdb2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pdb2a:0" aria-labelledby="tab:R9pdb2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"username1"</span>: <span class="token string">"You are not authorized to modify example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username2"</span>: <span class="token string">"You are not authorized to modify 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">"users_modified"</span>: <button class="collapser" aria-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></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">"command"</span>: <span class="token string">"twofactorauth_remove_user_config"</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/Two-Factor-Authentication/operation/twofactorauth_generate_tfa_config" data-section-id="tag/Two-Factor-Authentication/operation/twofactorauth_generate_tfa_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/twofactorauth_generate_tfa_config" id="operation/twofactorauth_generate_tfa_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Authentication/operation/twofactorauth_generate_tfa_config" aria-label="tag/Two-Factor-Authentication/operation/twofactorauth_generate_tfa_config"></a>Create a one-time authentication secret and code<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function generates a random secret and a one-time password authentication (OTP auth) URL for the user. Use the secret that this function returns and a valid verification token with WHM API 1&#39;s <code>twofactorauth_set_tfa_config</code> function to configure Two-Factor Authentication (2FA) on an account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function generates a random secret and a one-time password authentication (OTP auth) URL for the user. Use the secret that this function returns and a valid verification token with WHM API 1's <code>twofactorauth_set_tfa_config</code> function to configure Two-Factor Authentication (2FA) 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/twofactorauth_generate_tfa_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/twofactorauth_generate_tfa_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:R99fb2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99fb2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99fb2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99fb2a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99fb2a:0" aria-labelledby="tab:R99fb2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
twofactorauth_generate_tfa_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99fb2a:1" aria-labelledby="tab:R99fb2a: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:R9pfb2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pfb2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pfb2a:0" aria-labelledby="tab:R9pfb2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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:root?secret=CAOXW75HKYJJ6E5Y&issuer=Example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"secret"</span>: <span class="token string">"WJ73QJSKZBXCFIPZ"</span></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">"command"</span>: <span class="token string">"twofactorauth_generate_tfa_config"</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/Two-Factor-Authentication/operation/twofactorauth_policy_status" data-section-id="tag/Two-Factor-Authentication/operation/twofactorauth_policy_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/twofactorauth_policy_status" id="operation/twofactorauth_policy_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Authentication/operation/twofactorauth_policy_status" aria-label="tag/Two-Factor-Authentication/operation/twofactorauth_policy_status"></a>Return 2FA policy status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function displays the Two-Factor Authentication (2FA) policy status on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function displays the Two-Factor Authentication (2FA) policy status on the 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/twofactorauth_policy_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/twofactorauth_policy_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:R99hb2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99hb2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99hb2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99hb2a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99hb2a:0" aria-labelledby="tab:R99hb2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
twofactorauth_policy_status
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99hb2a:1" aria-labelledby="tab:R99hb2a: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:R9phb2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9phb2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9phb2a:0" aria-labelledby="tab:R9phb2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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></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">"command"</span>: <span class="token string">"twofactorauth_policy_status"</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/Two-Factor-Authentication/operation/twofactorauth_get_user_configs" data-section-id="tag/Two-Factor-Authentication/operation/twofactorauth_get_user_configs" class="sc-dntaoT ceciOs"><div data-section-id="operation/twofactorauth_get_user_configs" id="operation/twofactorauth_get_user_configs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Authentication/operation/twofactorauth_get_user_configs" aria-label="tag/Two-Factor-Authentication/operation/twofactorauth_get_user_configs"></a>Return cPanel accounts with 2FA enabled<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a list of user-controlled accounts and whether the accounts have Two-Factor Authentication (2FA) enabled.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of user-controlled accounts and whether the accounts have Two-Factor Authentication (2FA) 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><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=example</span></div><div><div html="<p>The username for a specified account.</p>
<p><strong>Note:</strong></p>
<p>If you do <strong>not</strong> specify a value, the function returns <strong>all</strong> user accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username for a specified account.</p>
<p><strong>Note:</strong></p>
<p>If you do <strong>not</strong> specify a value, the function returns <strong>all</strong> user accounts.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><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 data that the function returns.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The data that the function returns.</p>
</div></div></div></td></tr><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">/twofactorauth_get_user_configs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/twofactorauth_get_user_configs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99jb2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99jb2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99jb2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99jb2a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99jb2a:0" aria-labelledby="tab:R99jb2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
twofactorauth_get_user_configs
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99jb2a:1" aria-labelledby="tab:R99jb2a: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:R9pjb2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pjb2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pjb2a:0" aria-labelledby="tab:R9pjb2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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"</span>: <button class="collapser" aria-label="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">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"primary_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">"metadata"</span>: <button class="collapser" aria-label="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">"twofactorauth_get_user_configs"</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/Two-Factor-Authentication/operation/twofactorauth_set_tfa_config" data-section-id="tag/Two-Factor-Authentication/operation/twofactorauth_set_tfa_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/twofactorauth_set_tfa_config" id="operation/twofactorauth_set_tfa_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Authentication/operation/twofactorauth_set_tfa_config" aria-label="tag/Two-Factor-Authentication/operation/twofactorauth_set_tfa_config"></a>Update 2FA authentication secret and code<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the secret and the authentication code for Two-Factor Authentication (2FA) for the <code>root</code> or reseller account. You can generate a random secret and an OTP authentication URL with WHM API 1&#39;s <code>twofactorauth_generate_tfa_configorauth_generate_tfa_config</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the secret and the authentication code for Two-Factor Authentication (2FA) for the <code>root</code> or reseller account. You can generate a random secret and an OTP authentication URL with WHM API 1's <code>twofactorauth_generate_tfa_configorauth_generate_tfa_config</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="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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">secret=WJ73QJSKZBXCFIPZ</span></div><div><div html="<p>A generated code for use with 2FA in Base32 format.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A generated code for use with 2FA in Base32 format.</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">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">tfa_token=227174</span></div><div><div html="<p>The time-based one-time password (TOTP) that the authentication app provides.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The time-based one-time password (TOTP) that the authentication app provides.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/twofactorauth_set_tfa_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/twofactorauth_set_tfa_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:R99lb2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99lb2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99lb2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99lb2a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99lb2a:0" aria-labelledby="tab:R99lb2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
twofactorauth_set_tfa_config <span class="token punctuation">\</span>
<span class="token assign-left variable">secret</span><span class="token operator">=</span><span class="token string">'WJ73QJSKZBXCFIPZ'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">tfa_token</span><span class="token operator">=</span><span class="token string">'227174'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99lb2a:1" aria-labelledby="tab:R99lb2a: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:R9plb2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9plb2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9plb2a:0" aria-labelledby="tab:R9plb2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"metadata"</span>: <button class="collapser" aria-label="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">"twofactorauth_set_tfa_config"</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/Two-Factor-Authentication/operation/twofactorauth_set_issuer" data-section-id="tag/Two-Factor-Authentication/operation/twofactorauth_set_issuer" class="sc-dntaoT ceciOs"><div data-section-id="operation/twofactorauth_set_issuer" id="operation/twofactorauth_set_issuer" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Authentication/operation/twofactorauth_set_issuer" aria-label="tag/Two-Factor-Authentication/operation/twofactorauth_set_issuer"></a>Update 2FA issuer value<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the <code>issuer</code> value that the system uses to generate the <code>secret</code> and <code>otpurls</code> values for Two-Factor Authentication on your accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the <code>issuer</code> value that the system uses to generate the <code>secret</code> and <code>otpurls</code> values for Two-Factor Authentication on your 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="issuer" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">issuer</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">issuer=hostname.example.com</span></div><div><div html="<p>The issuer&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The issuer'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="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">/twofactorauth_set_issuer</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/twofactorauth_set_issuer</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99nb2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99nb2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99nb2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99nb2a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99nb2a:0" aria-labelledby="tab:R99nb2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
twofactorauth_set_issuer <span class="token punctuation">\</span>
<span class="token assign-left variable">issuer</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:R99nb2a:1" aria-labelledby="tab:R99nb2a: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:R9pnb2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pnb2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pnb2a:0" aria-labelledby="tab:R9pnb2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"twofactorauth_set_issuer"</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/Backup-Destination" data-section-id="tag/Backup-Destination" 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-Destination" aria-label="tag/Backup-Destination"></a>Backup Destination</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Backups / Backup Destination</p>
"><p>Backups / Backup Destination</p>
</div></div></div><div id="tag/Backup-Destination/operation/backup_destination_add" data-section-id="tag/Backup-Destination/operation/backup_destination_add" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_destination_add" id="operation/backup_destination_add" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Destination/operation/backup_destination_add" aria-label="tag/Backup-Destination/operation/backup_destination_add"></a>Add a backup destination<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds a backup destination.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds a backup destination.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="application_key" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">application_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">application_key=A123b45CD678e9</span></div><div><div html="<p>The application key&#39;s name.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>Backblaze</code> backup type.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application key's name.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>Backblaze</code> backup type.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="application_key_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">application_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">application_key_id=12a345B678c9</span></div><div><div html="<p>The application key ID that authenticates the Backblaze B2 account.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>Backblaze</code> backup type.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application key ID that authenticates the Backblaze B2 account.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>Backblaze</code> backup type.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="authtype" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">authtype</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"password"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"key"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">authtype=password</span></div><div><div html="<p>The authorization type.</p>
<ul>
<li><code>password</code></li>
<li><code>key</code></li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The authorization type.</p>
<ul>
<li><code>password</code></li>
<li><code>key</code></li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="aws_access_key_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">aws_access_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">aws_access_key_id=AKIAYLWMPOZZJCERC28Q</span></div><div><div html="<p>The Amazon S3™ Access Key ID.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>AmazonS3</code></li>
<li><code>S3Compatible</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Amazon S3™ Access Key ID.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>AmazonS3</code></li>
<li><code>S3Compatible</code></li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="bucket" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">bucket</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">bucket=ChockFullOfNuts</span></div><div><div html="<p>The Amazon S3™ bucket.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>AmazonS3</code></li>
<li><code>S3Compatible</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Amazon S3™ bucket.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>AmazonS3</code></li>
<li><code>S3Compatible</code></li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="bucket_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">bucket_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">bucket_id=a12b34cd5678e9f</span></div><div><div html="<p>The bucket&#39;s ID string.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>Backblaze</code> backup type.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The bucket's ID string.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>Backblaze</code> backup type.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="bucket_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">bucket_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">bucket_name=ChockFullOfNuts</span></div><div><div html="<p>The bucket&#39;s name.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>Backblaze</code> backup type.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The bucket's name.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>Backblaze</code> backup type.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="client_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">client_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">client_id=aBcdeFgHIjK123</span></div><div><div html="<p>The Google Drive client ID.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>GoogleDrive</code> backup type.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Google Drive client ID.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>GoogleDrive</code> backup type.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="client_secret" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">client_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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">client_secret=aBcde123FgHIjK456</span></div><div><div html="<p>The Google Drive client secret.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>GoogleDrive</code> backup type.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Google Drive client secret.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>GoogleDrive</code> backup type.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="disabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">disabled</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">disabled=0</span></div><div><div html="<p>Whether to disable the backup destination.</p>
<ul>
<li><code>1</code> — Disable the backup destination.</li>
<li><code>0</code> — Enable the backup destination.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to disable the backup destination.</p>
<ul>
<li><code>1</code> — Disable the backup destination.</li>
<li><code>0</code> — Enable the backup destination.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="folder" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">folder</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">folder=subfolder</span></div><div><div html="<p>The path to the backups directory on the remote server.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>AmazonS3</code></li>
<li><code>GoogleDrive</code></li>
<li><code>S3Compatible</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The path to the backups directory on the remote server.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>AmazonS3</code></li>
<li><code>GoogleDrive</code></li>
<li><code>S3Compatible</code></li>
</ul>
</div></div></div></td></tr><tr class=""><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><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->hostname<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">host=backups.example.com</span></div><div><div html="<p>The remote server&#39;s hostname.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>Custom</code></li>
<li><code>FTP</code></li>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
<li><code>WebDAV</code></li>
<li><code>S3Compatible</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server's hostname.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>Custom</code></li>
<li><code>FTP</code></li>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
<li><code>WebDAV</code></li>
<li><code>S3Compatible</code></li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="mount" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mount</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">mount=1</span></div><div><div html="<p>Whether the path is mounted.</p>
<ul>
<li><code>1</code> — The path is mounted.</li>
<li><code>0</code> — The path is <strong>not</strong> mounted.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>Local</code> backup type.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the path is mounted.</p>
<ul>
<li><code>1</code> — The path is mounted.</li>
<li><code>0</code> — The path is <strong>not</strong> mounted.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>Local</code> backup type.</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=destination_name</span></div><div><div html="<p>The backup destination&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The backup destination's name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="no_mount_fail" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">no_mount_fail</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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_mount_fail=1</span></div><div><div html="<p>Whether to fail the backup attempt if the mount fails.</p>
<ul>
<li><code>1</code> — Fail the backup attempt.</li>
<li><code>0</code> — Do <strong>not</strong> fail the backup attempt.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>Local</code> backup type.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to fail the backup attempt if the mount fails.</p>
<ul>
<li><code>1</code> — Fail the backup attempt.</li>
<li><code>0</code> — Do <strong>not</strong> fail the backup attempt.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>Local</code> backup type.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="only_used_for_logs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">only_used_for_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"> <!-- -->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">only_used_for_logs=1</span></div><div><div html="<p>Whether to use this transport only for logs.</p>
<ul>
<li><code>1</code> — This destination will be skipped for regular backups.</li>
<li><code>0</code> — Both log and regular backups will be uploaded.</li>
</ul>
<p>This setting defaults to 0.
The only time log files get their own backup is via scripts/remote_log_transfer</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use this transport only for logs.</p>
<ul>
<li><code>1</code> — This destination will be skipped for regular backups.</li>
<li><code>0</code> — Both log and regular backups will be uploaded.</li>
</ul>
<p>This setting defaults to 0.
The only time log files get their own backup is via scripts/remote_log_transfer</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="passive" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">passive</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">passive=1</span></div><div><div html="<p>Whether to use passive FTP.</p>
<ul>
<li><code>1</code> — Use passive FTP.</li>
<li><code>0</code> — Use active FTP.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>FTP</code> backup type.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use passive FTP.</p>
<ul>
<li><code>1</code> — Use passive FTP.</li>
<li><code>0</code> — Use active FTP.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>FTP</code> backup type.</p>
</div></div></div></td></tr><tr class=""><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"> <!-- -->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 private key file&#39;s passphrase, if the <code>authtype</code> parameter is the <code>key</code> value.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The private key file's passphrase, if the <code>authtype</code> parameter is the <code>key</code> value.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>SFTP</code></li>
<li><code>Rsync</code></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 remote server account&#39;s password or secret
access key.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>AmazonS3</code></li>
<li><code>Custom</code></li>
<li><code>FTP</code></li>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
<li><code>WebDAV</code></li>
<li><code>S3Compatible</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server account's password or secret
access key.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>AmazonS3</code></li>
<li><code>Custom</code></li>
<li><code>FTP</code></li>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
<li><code>WebDAV</code></li>
<li><code>S3Compatible</code></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></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">path=backups</span></div><div><div html="<p>The path to the backups directory on the remote server.</p>
<ul>
<li>This parameter is <strong>required</strong> for the <code>Local</code> backup type.</li>
<li>If you do <strong>not</strong> use this parameter, the system will not set a value.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>Backblaze</code></li>
<li><code>Custom</code></li>
<li><code>Local</code></li>
<li><code>FTP</code></li>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
<li><code>WebDAV</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The path to the backups directory on the remote server.</p>
<ul>
<li>This parameter is <strong>required</strong> for the <code>Local</code> backup type.</li>
<li>If you do <strong>not</strong> use this parameter, the system will not set a value.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>Backblaze</code></li>
<li><code>Custom</code></li>
<li><code>Local</code></li>
<li><code>FTP</code></li>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
<li><code>WebDAV</code></li>
</ul>
</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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">port=21</span></div><div><div html="<p>The TCP port to use.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This parameter defaults to the standard port used by the queried backup <code>type</code> parameter.</li>
<li>This parameter is only valid for the following backup types:<ul>
<li><code>FTP</code></li>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
<li><code>WebDAV</code></li>
</ul>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The TCP port to use.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This parameter defaults to the standard port used by the queried backup <code>type</code> parameter.</li>
<li>This parameter is only valid for the following backup types:<ul>
<li><code>FTP</code></li>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
<li><code>WebDAV</code></li>
</ul>
</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="privatekey" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">privatekey</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">privatekey=/home/backups/key</span></div><div><div html="<p>The file path to the private key file, if the <code>authtype</code> parameter is the <code>key</code> value.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The file path to the private key file, if the <code>authtype</code> parameter is the <code>key</code> value.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="script" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">script</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">script=/home/backups/beammeupscotty.pl</span></div><div><div html="<p>The absolute file path to the user-supplied transport solution script.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>Custom</code> backup type.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute file path to the user-supplied transport solution script.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>Custom</code> backup type.</p>
</div></div></div></td></tr><tr class=""><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">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">ssl=1</span></div><div><div html="<p>Whether to use SSL.</p>
<ul>
<li><code>1</code> — Use SSL.</li>
<li><code>0</code> — Do <strong>not</strong> use SSL.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>WebDAV</code> backup type.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use SSL.</p>
<ul>
<li><code>1</code> — Use SSL.</li>
<li><code>0</code> — Do <strong>not</strong> use SSL.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the <code>WebDAV</code> backup type.</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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">timeout=30</span></div><div><div html="<p>The session timeout, measured in seconds.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This parameter is <strong>not</strong> valid for the <code>Local</code> backup <code>type</code> parameter.</li>
<li>The default value depends on the <code>type</code> parameter&#39;s value.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The session timeout, measured in seconds.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This parameter is <strong>not</strong> valid for the <code>Local</code> backup <code>type</code> parameter.</li>
<li>The default value depends on the <code>type</code> parameter's value.</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">"Custom"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"FTP"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Local"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"SFTP"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"WebDAV"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"AmazonS3"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Rsync"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"GoogleDrive"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"S3Compatible"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Backblaze"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=Local</span></div><div><div html="<p>The type of backup destination.</p>
<ul>
<li><code>Custom</code></li>
<li><code>FTP</code></li>
<li><code>Local</code></li>
<li><code>SFTP</code></li>
<li><code>WebDAV</code></li>
<li><code>AmazonS3</code></li>
<li><code>Rsync</code></li>
<li><code>GoogleDrive</code></li>
<li><code>S3Compatible</code></li>
<li><code>Backblaze</code></li>
</ul>
<p><strong>Note:</strong></p>
<p>This value determines which parameters you can use with the function.</p>
<p><strong>Warning:</strong></p>
<p>Use any of these encrypted connections to transfer system backup files:</p>
<ul>
<li>Amazon S3™</li>
<li>Backblaze</li>
<li>GoogleDrive</li>
<li>Rsync</li>
<li>S3 Compatible</li>
<li>SFTP</li>
<li>WebDAV with SSL enabled</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of backup destination.</p>
<ul>
<li><code>Custom</code></li>
<li><code>FTP</code></li>
<li><code>Local</code></li>
<li><code>SFTP</code></li>
<li><code>WebDAV</code></li>
<li><code>AmazonS3</code></li>
<li><code>Rsync</code></li>
<li><code>GoogleDrive</code></li>
<li><code>S3Compatible</code></li>
<li><code>Backblaze</code></li>
</ul>
<p><strong>Note:</strong></p>
<p>This value determines which parameters you can use with the function.</p>
<p><strong>Warning:</strong></p>
<p>Use any of these encrypted connections to transfer system backup files:</p>
<ul>
<li>Amazon S3™</li>
<li>Backblaze</li>
<li>GoogleDrive</li>
<li>Rsync</li>
<li>S3 Compatible</li>
<li>SFTP</li>
<li>WebDAV with SSL enabled</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="upload_system_backup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">upload_system_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">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">upload_system_backup=1</span></div><div><div html="<p>Whether to upload system backups.</p>
<ul>
<li><code>1</code> — Upload system backups.</li>
<li><code>0</code> — Do <strong>not</strong> upload system backups.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to upload system backups.</p>
<ul>
<li><code>1</code> — Upload system backups.</li>
<li><code>0</code> — Do <strong>not</strong> upload system backups.</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=username</span></div><div><div html="<p>The remote server account&#39;s username.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>Custom</code></li>
<li><code>FTP</code></li>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
<li><code>WebDAV</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server account's username.</p>
<p><strong>Note:</strong></p>
<p>This parameter is only valid for the following backup types:</p>
<ul>
<li><code>Custom</code></li>
<li><code>FTP</code></li>
<li><code>SFTP</code></li>
<li><code>Rsync</code></li>
<li><code>WebDAV</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/backup_destination_add</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_destination_add</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99332q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99332q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99332q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99332q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99332q:0" aria-labelledby="tab:R99332q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_destination_add <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'destination_name'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'Local'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">disabled</span><span class="token operator">=</span><span class="token string">'0'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">bucket</span><span class="token operator">=</span><span class="token string">'ChockFullOfNuts'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">aws_access_key_id</span><span class="token operator">=</span><span class="token string">'AKIAYLWMPOZZJCERC28Q'</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">application_key</span><span class="token operator">=</span><span class="token string">'A123b45CD678e9'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">application_key_id</span><span class="token operator">=</span><span class="token string">'12a345B678c9'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">bucket_id</span><span class="token operator">=</span><span class="token string">'a12b34cd5678e9f'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">bucket_name</span><span class="token operator">=</span><span class="token string">'ChockFullOfNuts'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">script</span><span class="token operator">=</span><span class="token string">'/home/backups/beammeupscotty.pl'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'backups.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">client_id</span><span class="token operator">=</span><span class="token string">'aBcdeFgHIjK123'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">client_secret</span><span class="token operator">=</span><span class="token string">'aBcde123FgHIjK456'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">authtype</span><span class="token operator">=</span><span class="token string">'password'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99332q:1" aria-labelledby="tab:R99332q: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:R9p332q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p332q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p332q:0" aria-labelledby="tab:R9p332q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"PhAxIoLSdIkCI40q9vWS4BYy"</span></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">"command"</span>: <span class="token string">"backup_destination_add"</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/Backup-Destination/operation/backup_destination_delete" data-section-id="tag/Backup-Destination/operation/backup_destination_delete" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_destination_delete" id="operation/backup_destination_delete" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Destination/operation/backup_destination_delete" aria-label="tag/Backup-Destination/operation/backup_destination_delete"></a>Delete a backup destination<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes a backup destination from the backup configuration file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a backup destination from the backup configuration 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="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=11111111</span></div><div><div html="<p>The destination&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The destination'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="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">/backup_destination_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_destination_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:R99532q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99532q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99532q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99532q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99532q:0" aria-labelledby="tab:R99532q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_destination_delete <span class="token punctuation">\</span>
<span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'11111111'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99532q:1" aria-labelledby="tab:R99532q: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:R9p532q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p532q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p532q:0" aria-labelledby="tab:R9p532q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"backup_destination_delete"</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/Backup-Destination/operation/backup_destination_get" data-section-id="tag/Backup-Destination/operation/backup_destination_get" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_destination_get" id="operation/backup_destination_get" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Destination/operation/backup_destination_get" aria-label="tag/Backup-Destination/operation/backup_destination_get"></a>Return a backup destination's settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>Use this function to obtain a backup destination&#39;s settings.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Use this function to obtain a backup destination'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="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=0W1ei2rd3A4lI5sT6he7Be8st</span></div><div><div html="<p>The backup destination&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The backup destination'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><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><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->BackupDestinationGetResponse<!-- -->) </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="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">/backup_destination_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_destination_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:R99732q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99732q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99732q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99732q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99732q:0" aria-labelledby="tab:R99732q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_destination_get <span class="token punctuation">\</span>
<span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'0W1ei2rd3A4lI5sT6he7Be8st'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99732q:1" aria-labelledby="tab:R99732q: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:R9p732q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p732q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p732q:0" aria-labelledby="tab:R9p732q:0"><div><div class="sc-Rjrgp dIDLbO"><span 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="type=AmazonS3" selected="">type=AmazonS3</option><option value="type=BackBlaze">type=BackBlaze</option><option value="type=Custom">type=Custom</option><option value="type=FTP">type=FTP</option><option value="type=GoogleDrive">type=GoogleDrive</option><option value="type=Local">type=Local</option><option value="type=Rsync">type=Rsync</option><option value="type=S3Compatable">type=S3Compatable</option><option value="type=SFTP">type=SFTP</option><option value="type=WebDAV">type=WebDAV</option></select><label>type=AmazonS3</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">"aws_access_key_id"</span>: <span class="token string">"access-key-id"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bucket"</span>: <span class="token string">"s3-bucket-brigade"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"folder"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"Sr1ThYOnnBIXUupTcSBYQywk"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Amazon S3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timeout"</span>: <span class="token number">30</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"AmazonS3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"upload_system_backup"</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">"metadata"</span>: <button class="collapser" aria-label="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">"backup_destination_get"</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><div id="tag/Backup-Destination/operation/backup_destination_set" data-section-id="tag/Backup-Destination/operation/backup_destination_set" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_destination_set" id="operation/backup_destination_set" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Destination/operation/backup_destination_set" aria-label="tag/Backup-Destination/operation/backup_destination_set"></a>Update backup destination settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>Use this function to edit a backup destination&#39;s settings.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Use this function to edit a backup destination'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><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">application/x-www-form-urlencoded</span><div class="sc-CNKsk sc-hGZxvd sc-kLJHhQ hPAOR feFoaC fRACBr">required</div></h5><div html="<p>The destination settings.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>The destination settings.</p>
</div><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="aws_access_key_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">aws_access_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><div html="<p>The Amazon S3 Access Key ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Amazon S3 Access Key ID.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="bucket" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">bucket</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The Amazon S3™ bucket.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Amazon S3™ bucket.</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><div html="<p>The ID of the backup destination to modify.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ID of the backup destination to modify.</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><div html="<p>The Amazon S3 Access Key&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Amazon S3 Access Key's password.</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><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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"> <!-- -->[ 30 .. 300 ]<!-- --> </span></span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">30</span></div> <div><div html="<p>The session timeout, in seconds.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The session timeout, in seconds.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="disable_reason" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">disable_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><div html="<p>An error message that explains why the backup is disabled.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An error message that explains why the backup is disabled.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="disabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">disabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether to disable the backup destination.</p>
<ul>
<li><code>1</code> — Disable the destination.</li>
<li><code>0</code> — Enable the destination.</li>
</ul>
<p><strong>Note:</strong></p>
<p>If you do not set this parameter, the system retains the current setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to disable the backup destination.</p>
<ul>
<li><code>1</code> — Disable the destination.</li>
<li><code>0</code> — Enable the destination.</li>
</ul>
<p><strong>Note:</strong></p>
<p>If you do not set this parameter, the system retains the current setting.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="folder" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">folder</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">""</span></div> <div><div html="<p>The path to the backups directory, relative to the root directory, on the remote server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The path to the backups directory, relative to the root directory, on the remote server.</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><div html="<p>A new name for the backup destination.</p>
<p><strong>Note:</strong></p>
<p>If you do not set this parameter, the system retains the current setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A new name for the backup destination.</p>
<p><strong>Note:</strong></p>
<p>If you do not set this parameter, the system retains the current setting.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="only_used_for_logs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">only_used_for_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><div html="<p>Whether to use this transport only for logs.</p>
<ul>
<li><code>1</code> — This destination will be skipped for regular backups.</li>
<li><code>0</code> — Both log and regular backups will be uploaded.</li>
</ul>
<p>This setting defaults to 0.
The only time log files get their own backup is via scripts/remote_log_transfer</p>
<p><strong>Note:</strong></p>
<p>If you do not set this parameter, the system retains the current setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use this transport only for logs.</p>
<ul>
<li><code>1</code> — This destination will be skipped for regular backups.</li>
<li><code>0</code> — Both log and regular backups will be uploaded.</li>
</ul>
<p>This setting defaults to 0.
The only time log files get their own backup is via scripts/remote_log_transfer</p>
<p><strong>Note:</strong></p>
<p>If you do not set this parameter, the system retains the current setting.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The type of backup destination.</p>
<p><strong>Note:</strong></p>
<p>If you do not set this parameter, the system retains the current setting.</p>
<p>Select a backup destination from the following menu to view its optional parameters:</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of backup destination.</p>
<p><strong>Note:</strong></p>
<p>If you do not set this parameter, the system retains the current setting.</p>
<p>Select a backup destination from the following menu to view its optional parameters:</p>
</div></div><div class="sc-diYFot jsRqjj"><svg class="sc-kZrBCu bweot" 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="Custom">Custom</option><option value="FTP">FTP</option><option value="Local">Local</option><option value="SFTP">SFTP</option><option value="WebDAV">WebDAV</option><option value="AmazonS3" selected="">AmazonS3</option><option value="Rsync">Rsync</option><option value="GoogleDrive">GoogleDrive</option><option value="S3Compatible">S3Compatible</option><option value="Backblaze">Backblaze</option></select><label>AmazonS3</label></div></div></td></tr><tr class="last "><td kind="field" title="upload_system_backup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">upload_system_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">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><div html="<p>Whether to upload system backups.</p>
<ul>
<li><code>1</code> — Upload.</li>
<li><code>0</code> — Do <strong>not</strong> upload.</li>
</ul>
<p><strong>Note:</strong></p>
<p>If you do not set this parameter, the system retains the current setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to upload system backups.</p>
<ul>
<li><code>1</code> — Upload.</li>
<li><code>0</code> — Do <strong>not</strong> upload.</li>
</ul>
<p><strong>Note:</strong></p>
<p>If you do not set this parameter, the system retains the current setting.</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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/backup_destination_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_destination_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:R99932q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99932q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99932q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99932q: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:R99932q:0" aria-labelledby="tab:R99932q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <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>
backup_destination_set
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99932q:1" aria-labelledby="tab:R99932q: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:R9p932q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p932q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p932q:0" aria-labelledby="tab:R9p932q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"backup_destination_set"</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/Backup-Destination/operation/backup_does_client_id_have_google_credentials" data-section-id="tag/Backup-Destination/operation/backup_does_client_id_have_google_credentials" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_does_client_id_have_google_credentials" id="operation/backup_does_client_id_have_google_credentials" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Destination/operation/backup_does_client_id_have_google_credentials" aria-label="tag/Backup-Destination/operation/backup_does_client_id_have_google_credentials"></a>Return Google Drive™ client ID credentials<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns whether a Google Drive™ client ID credential file exists.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns whether a Google Drive™ client ID credential file exists.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="client_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">client_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">client_id=aBcdeFgHIjK123</span></div><div><div html="<p>The user&#39;s Google Drive client ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user's Google Drive client 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/backup_does_client_id_have_google_credentials</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_does_client_id_have_google_credentials</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b32q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b32q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b32q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b32q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b32q:0" aria-labelledby="tab:R99b32q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_does_client_id_have_google_credentials <span class="token punctuation">\</span>
<span class="token assign-left variable">client_id</span><span class="token operator">=</span><span class="token string">'aBcdeFgHIjK123'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b32q:1" aria-labelledby="tab:R99b32q: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:R9pb32q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb32q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb32q:0" aria-labelledby="tab:R9pb32q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exists"</span>: <span class="token number">1</span></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">"command"</span>: <span class="token string">"backup_does_client_id_have_google_credentials"</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/Backup-Destination/operation/backup_destination_validate" data-section-id="tag/Backup-Destination/operation/backup_destination_validate" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_destination_validate" id="operation/backup_destination_validate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Destination/operation/backup_destination_validate" aria-label="tag/Backup-Destination/operation/backup_destination_validate"></a>Validate a backup destination<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function validates a backup destination.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function validates a backup destination.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="disableonfail" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">disableonfail</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">disableonfail=1</span></div><div><div html="<p>Whether to disable the backup destination if validation fails.</p>
<ul>
<li><code>1</code> — Disable.</li>
<li><code>0</code> — Do <strong>not</strong> disable.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to disable the backup destination if validation fails.</p>
<ul>
<li><code>1</code> — Disable.</li>
<li><code>0</code> — Do <strong>not</strong> 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=0W1ei2rd3A4lI5sT6he7Be8st</span></div><div><div html="<p>The destination&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The destination'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/backup_destination_validate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_destination_validate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d32q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d32q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d32q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d32q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d32q:0" aria-labelledby="tab:R99d32q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_destination_validate <span class="token punctuation">\</span>
<span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'0W1ei2rd3A4lI5sT6he7Be8st'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">disableonfail</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:R99d32q:1" aria-labelledby="tab:R99d32q: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:R9pd32q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd32q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd32q:0" aria-labelledby="tab:R9pd32q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"0W1ei2rd3A4lI5sT6he7Be8st"</span></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">"command"</span>: <span class="token string">"backup_destination_validate"</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/Backup-Destination/operation/backup_generate_google_oauth_uri" data-section-id="tag/Backup-Destination/operation/backup_generate_google_oauth_uri" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_generate_google_oauth_uri" id="operation/backup_generate_google_oauth_uri" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Destination/operation/backup_generate_google_oauth_uri" aria-label="tag/Backup-Destination/operation/backup_generate_google_oauth_uri"></a>Create Google Drive™ OAuth redirect URI<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function generates a
<a href="https://developers.google.com/identity/protocols/OAuth2InstalledApp">Google Drive™ OAuth redirect URI</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function generates a
<a href="https://developers.google.com/identity/protocols/OAuth2InstalledApp">Google Drive™ OAuth redirect URI</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="client_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">client_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">client_id=aBcdeFgHIjK123</span></div><div><div html="<p>The Google Drive client ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Google Drive client ID.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="client_secret" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">client_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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">client_secret=aBcde123FgHIjK456</span></div><div><div html="<p>The Google Drive
<a href="https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/">client secret</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Google Drive
<a href="https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/">client secret</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/backup_generate_google_oauth_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_generate_google_oauth_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:R99f32q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f32q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f32q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f32q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f32q:0" aria-labelledby="tab:R99f32q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_generate_google_oauth_uri <span class="token punctuation">\</span>
<span class="token assign-left variable">client_id</span><span class="token operator">=</span><span class="token string">'aBcdeFgHIjK123'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">client_secret</span><span class="token operator">=</span><span class="token string">'aBcde123FgHIjK456'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f32q:1" aria-labelledby="tab:R99f32q: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:R9pf32q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf32q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf32q:0" aria-labelledby="tab:R9pf32q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"</span><a href="https://accounts.google.com/o/oauth2/auth?client_id=aBcdeFgHIjK123&response_type=code&redirect_uri=https%253A%252F%252Fhost-10-0-0-2.example.tld%253A2087%252Fgoogledriveauth%252Fcallback&scope=https%253A%252F%252Fwww.googleapis.com%252Fauth%252Fdrive.file&access_type=offline&prompt=consent&state=IkdLqOej5CLPW1nHRF6OJYaahE7HPXrRUvpFs6MhmBMbCjvWDQcstyYhbUFge5IJ">https://accounts.google.com/o/oauth2/auth?client_id=aBcdeFgHIjK123&response_type=code&redirect_uri=https%3A%2F%2Fhost-10-0-0-2.example.tld%3A2087%2Fgoogledriveauth%2Fcallback&scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fdrive.file&access_type=offline&prompt=consent&state=IkdLqOej5CLPW1nHRF6OJYaahE7HPXrRUvpFs6MhmBMbCjvWDQcstyYhbUFge5IJ</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">"metadata"</span>: <button class="collapser" aria-label="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">"backup_generate_google_oauth_uri"</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/Backup-Destination/operation/backup_destination_list" data-section-id="tag/Backup-Destination/operation/backup_destination_list" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_destination_list" id="operation/backup_destination_list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Destination/operation/backup_destination_list" aria-label="tag/Backup-Destination/operation/backup_destination_list"></a>Return a list of backup destinations<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists backup destinations.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists backup destinations.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/backup_destination_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_destination_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:R99h32q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h32q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h32q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h32q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h32q:0" aria-labelledby="tab:R99h32q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_destination_list
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h32q:1" aria-labelledby="tab:R99h32q: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:R9ph32q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph32q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph32q:0" aria-labelledby="tab:R9ph32q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_list"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"disable_reason"</span>: <span class="token string">"Could not list files in destination: example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disabled"</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">"0W1ei2rd3A4lI5sT6he7Be8st"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"destination_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"Local"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"aws_access_key_id"</span>: <span class="token string">"s123456789"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bucket"</span>: <span class="token string">"ChockFullOfNuts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"folder"</span>: <span class="token string">"subfolder"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timeout"</span>: <span class="token number">300</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">"metadata"</span>: <button class="collapser" aria-label="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">"backup_destination_list"</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/Backup-or-Restore" data-section-id="tag/Backup-or-Restore" 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-or-Restore" aria-label="tag/Backup-or-Restore"></a>Backup or Restore</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Backups / Backup or Restore</p>
"><p>Backups / Backup or Restore</p>
</div></div></div><div id="tag/Backup-or-Restore/operation/backup_list_transported" data-section-id="tag/Backup-or-Restore/operation/backup_list_transported" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_list_transported" id="operation/backup_list_transported" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-or-Restore/operation/backup_list_transported" aria-label="tag/Backup-or-Restore/operation/backup_list_transported"></a>Return backup files sent through transport<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists backup files that the system sent through a specified additional backup transport.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists backup files that the system sent through a specified additional backup transport.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="transport" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">transport</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">transport=nN04BhzirlJUNSLSBXSMBEYG</span></div><div><div html="<p>The transport ID.</p>
<p>If you do not specify this parameter, the function returns backup information for all transports.</p>
<p><strong>Note:</strong></p>
<p>You may obtain the IDs for all configured transports by calling WHM API 1&#39;s <code>backup_destination_list</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The transport ID.</p>
<p>If you do not specify this parameter, the function returns backup information for all transports.</p>
<p><strong>Note:</strong></p>
<p>You may obtain the IDs for all configured transports by calling WHM API 1's <code>backup_destination_list</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/backup_list_transported</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_list_transported</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99352q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99352q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99352q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99352q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99352q:0" aria-labelledby="tab:R99352q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_list_transported
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99352q:1" aria-labelledby="tab:R99352q: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:R9p352q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p352q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p352q:0" aria-labelledby="tab:R9p352q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_backups"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"nN04BhzirlJUNSLSBXSMBEYG"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"janedoe"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"2020-08-28T00:00:00.000Z"</span>,</div></li><li><div class="hoverable "><span class="token string">"2020-08-31T00:00:00.000Z"</span>,</div></li><li><div class="hoverable "><span class="token string">"2020-09-02T00:00:00.000Z"</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">"metadata"</span>: <button class="collapser" aria-label="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">"backup_list_transported"</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/Backup-or-Restore/operation/backup_set_list_combined" data-section-id="tag/Backup-or-Restore/operation/backup_set_list_combined" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_set_list_combined" id="operation/backup_set_list_combined" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-or-Restore/operation/backup_set_list_combined" aria-label="tag/Backup-or-Restore/operation/backup_set_list_combined"></a>Return backup files for the server's accounts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists locally-stored and backup-destination stored backup files for the server&#39;s accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists locally-stored and backup-destination stored backup files for the server's 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/backup_set_list_combined</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_set_list_combined</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99552q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99552q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99552q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99552q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99552q:0" aria-labelledby="tab:R99552q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_set_list_combined
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99552q:1" aria-labelledby="tab:R99552q: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:R9p552q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p552q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p552q:0" aria-labelledby="tab:R9p552q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_set"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cpusername1"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"when"</span>: <span class="token string">"2020-01-25T00:00:00.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"where"</span>: <span class="token string">"local"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"when"</span>: <span class="token string">"2020-01-26T00:00:00.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"where"</span>: <span class="token string">"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">"cpusername2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"when"</span>: <span class="token string">"2020-01-25T00:00:00.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"where"</span>: <span class="token string">"local"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"when"</span>: <span class="token string">"2020-01-26T00:00:00.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"where"</span>: <span class="token string">"local"</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">"destination_legend"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"GLT1vFsVO8cqk2UWWFpJ9kSQ"</span>: <button class="collapser" aria-label="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">"More Backups"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"Local"</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">"metadata"</span>: <button class="collapser" aria-label="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">"backup_set_list_combined"</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/Backup-or-Restore/operation/fetch_pkgacct_master_log" data-section-id="tag/Backup-or-Restore/operation/fetch_pkgacct_master_log" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_pkgacct_master_log" id="operation/fetch_pkgacct_master_log" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-or-Restore/operation/fetch_pkgacct_master_log" aria-label="tag/Backup-or-Restore/operation/fetch_pkgacct_master_log"></a>Return start_background_pkgacct session log file<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the contents of a <code>start_background_pkgacct</code> session&#39;s master log file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the contents of a <code>start_background_pkgacct</code> session's master log 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="session_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">session_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">session_id=username20200323154328kDJ2Kx4xua2KtG</span></div><div><div html="<p>The <code>start_background_pkgacct</code> session ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <code>start_background_pkgacct</code> session 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/fetch_pkgacct_master_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/fetch_pkgacct_master_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:R99752q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99752q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99752q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99752q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99752q:0" aria-labelledby="tab:R99752q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
fetch_pkgacct_master_log <span class="token punctuation">\</span>
<span class="token assign-left variable">session_id</span><span class="token operator">=</span><span class="token string">'username20200323154328kDJ2Kx4xua2KtG'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99752q:1" aria-labelledby="tab:R99752q: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:R9p752q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p752q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p752q:0" aria-labelledby="tab:R9p752q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"{\"contents\":\"pkgacct started.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"partial\":0,\"contents\":\"pkgacct version 10 - user : username - tarball: 1 - target mysql : 5.7 - split: 1 - incremental: 0 - homedir: 0 - mailman: 1 - backup: 0 - archive version: 4 - running with uid 0\\n\",\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"partial\":0,\"contents\":\"pkgacct using ''/usr/local/cpanel/3rdparty/bin/pigz -6 --processes 1 --blocksize 4096 --rsyncable'' to compress archives\\n\"}\n{\"type\":\"out\",\"indent\":0,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"contents\":\"pkgacct -- attempting to use daily backup to create an account package\\n\",\"pid\":4073}\n{\"indent\":0,\"contents\":\"pkgacct -- could not use daily backup because no daily incremental backup for user username can be found ( check if daily incremental backups are enabled )\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"pid\":4073,\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"contents\":\"pkgacct working dir : /home/cpmove-username\",\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"contents\":\"Copying Reseller Config...\",\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"partial\":1}\n{\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"partial\":0,\"contents\":\"Done\\n\",\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"partial\":1,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"contents\":\"Copying Suspension Info (if needed)...\"}\n{\"type\":\"out\",\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"partial\":0,\"contents\":\"Done\\n\",\"pid\":4073,\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"contents\":\"Copying installed SSL certificates and keys...\",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:28 -0500\"}\n{\"type\":\"out\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"contents\":\"Performing ApacheTLS component....\",\"pid\":4073,\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"contents\":\"Completed ApacheTLS component.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073}\n{\"type\":\"out\",\"pid\":4073,\"contents\":\"Done\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"indent\":0}\n{\"indent\":0,\"contents\":\"Copying DKIM keys....\",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"contents\":\"Done\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073}\n{\"type\":\"out\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"contents\":\"Copying Bandwidth Data....\",\"pid\":4073,\"indent\":0}\n{\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Performing Bandwidth component....\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"contents\":\"Summary databases \",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"indent\":0}\n{\"type\":\"out\",\"contents\":\" done!\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"indent\":0}\n{\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Completed Bandwidth component.\\n\",\"type\":\"out\"}\n{\"indent\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Done\\n\",\"pid\":4073,\"type\":\"out\"}\n{\"type\":\"out\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"contents\":\"Copying Dns Zones....\",\"pid\":4073,\"indent\":0}\n{\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"contents\":\"...username.tld...\",\"type\":\"out\"}\n{\"indent\":0,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Done\\n\",\"pid\":4073,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"contents\":\"Copying Mail files....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1}\n{\"indent\":0,\"contents\":\"Done\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"type\":\"out\"}\n{\"contents\":\"Copying proftpd file....\",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"contents\":\"Done\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"type\":\"out\"}\n{\"indent\":0,\"contents\":\"Performing Logs component....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"contents\":\"...log file sizes [0 byte(s)]...\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"contents\":\"...username.tld-ssl_log...\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1}\n{\"contents\":\"...username.tld...\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"contents\":\"Completed Logs component.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"contents\":\"Copy userdata...\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"pid\":4073}\n{\"contents\":\"Done\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"contents\":\"Copy custom virtualhost templates...\",\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Done\\n\",\"pid\":4073}\n{\"type\":\"out\",\"contents\":\"Copying mailman lists and archives....\",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"contents\":\"Done copying mailman lists and archives.\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1}\n{\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Performing Postgresql component....\",\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"contents\":\"Completed Postgresql component.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Performing Mysql component....\",\"indent\":0}\n{\"contents\":\"Determining mysql dbs...\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"contents\":\"...mysqldump version: 5.7.27...\",\"indent\":0}\n{\"type\":\"out\",\"contents\":\"...mysql version: 5.7...\",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"contents\":\"Saving mysql privs...\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"pid\":4073}\n{\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Done\\n\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"contents\":\"Storing MySQL databases...\\n\",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Done\\n\",\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"...Done\\n\"}\n{\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"...Done\\n\",\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Completed Mysql component.\\n\"}\n{\"indent\":0,\"contents\":\"Performing MysqlRemoteNotes component....\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"type\":\"out\"}\n{\"indent\":0,\"contents\":\"Completed MysqlRemoteNotes component.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"type\":\"out\"}\n{\"pid\":4073,\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Copying cpuser file.......\",\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"contents\":\"Done\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073}\n{\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Copying crontab file.......\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"contents\":\"Done\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"contents\":\"Performing Quota component....\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"indent\":0}\n{\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Completed Quota component.\\n\",\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Performing Integration component....\",\"pid\":4073}\n{\"pid\":4073,\"contents\":\"Completed Integration component.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"contents\":\"Performing AuthnLinks component....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"contents\":\"Completed AuthnLinks component.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Performing APITokens component....\"}\n{\"indent\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Completed APITokens component.\\n\",\"pid\":4073,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Performing DNSSEC component....\",\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Completed DNSSEC component.\\n\",\"pid\":4073}\n{\"type\":\"out\",\"indent\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Performing Custom component....\",\"pid\":4073}\n{\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"No custom components to perform.\\n\",\"indent\":0,\"type\":\"out\"}\n{\"contents\":\"Completed Custom component.\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"contents\":\"Performing AutoSSL component....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0}\n{\"indent\":0,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Completed AutoSSL component.\\n\",\"pid\":4073,\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"contents\":\"Storing Subdomains....\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Done\\n\",\"pid\":4073}\n{\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Storing Parked Domains....\\n\",\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"contents\":\"Done\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"indent\":0}\n{\"indent\":0,\"contents\":\"Storing Addon Domains....\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"type\":\"out\"}\n{\"contents\":\"Performing Password component....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"contents\":\"Completed Password component.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073}\n{\"type\":\"out\",\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Performing DigestShadow component....\",\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Completed DigestShadow component.\\n\"}\n{\"type\":\"out\",\"indent\":0,\"contents\":\"Copying shell.......\",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"contents\":\"Done\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0}\n{\"indent\":0,\"pid\":4073,\"contents\":\"Performing PublicContact component....\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Completed PublicContact component.\\n\",\"type\":\"out\"}\n{\"contents\":\"Performing MailLimits component....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Completed MailLimits component.\\n\",\"pid\":4073,\"type\":\"out\"}\n{\"contents\":\"Performing LinkedNodes component....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Completed LinkedNodes component.\\n\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"pid\":4073,\"contents\":\"Creating Archive ....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"\\n\",\"type\":\"out\"}\n{\"contents\":\"splitpkgacctfile is: /home/cpmove-username-split/cpmove-username.tar.gz.part00001\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"\\nsplitmd5sum is: e06a2d1f0cb499cb1d5ff15116f02df4\\n\",\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"\\nsplitsize is: 7275\\n\",\"indent\":0}\n{\"type\":\"out\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Done\\n\",\"pid\":4073,\"indent\":0}\n{\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"\\nmysqlsize is: 0\\n\",\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"pkgacct completed\\n\",\"type\":\"out\"}"</span></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">"command"</span>: <span class="token string">"fetch_pkgacct_master_log"</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/Backup-or-Restore/operation/backup_set_list" data-section-id="tag/Backup-or-Restore/operation/backup_set_list" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_set_list" id="operation/backup_set_list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-or-Restore/operation/backup_set_list" aria-label="tag/Backup-or-Restore/operation/backup_set_list"></a>Return backup files in the local disk<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists backup files for the server&#39;s accounts in the local disk.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists backup files for the server's accounts in the local disk.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/backup_set_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_set_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:R99952q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99952q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99952q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99952q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99952q:0" aria-labelledby="tab:R99952q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_set_list
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99952q:1" aria-labelledby="tab:R99952q: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:R9p952q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p952q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p952q:0" aria-labelledby="tab:R9p952q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_set"</span>: <span class="token punctuation">{ }</span></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">"command"</span>: <span class="token string">"backup_set_list"</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/Backup-or-Restore/operation/get_pkgacct_session_state" data-section-id="tag/Backup-or-Restore/operation/get_pkgacct_session_state" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_pkgacct_session_state" id="operation/get_pkgacct_session_state" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-or-Restore/operation/get_pkgacct_session_state" aria-label="tag/Backup-or-Restore/operation/get_pkgacct_session_state"></a>Return start_background_pkgacct session state<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the state of a <code>start_background_pkgacct</code> session.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the state of a <code>start_background_pkgacct</code> session.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="session_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">session_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">session_id=username20200323154328kDJ2Kx4xua2KtG</span></div><div><div html="<p>The <code>start_background_pkgacct</code> session ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <code>start_background_pkgacct</code> session 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_pkgacct_session_state</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_pkgacct_session_state</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b52q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b52q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b52q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b52q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b52q:0" aria-labelledby="tab:R99b52q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_pkgacct_session_state <span class="token punctuation">\</span>
<span class="token assign-left variable">session_id</span><span class="token operator">=</span><span class="token string">'username20200323154328kDJ2Kx4xua2KtG'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b52q:1" aria-labelledby="tab:R99b52q: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:R9pb52q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb52q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb52q:0" aria-labelledby="tab:R9pb52q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">"COMPLETED"</span></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">"command"</span>: <span class="token string">"get_pkgacct_session_state"</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/Backup-or-Restore/operation/get_users_and_domains_with_backup_metadata" data-section-id="tag/Backup-or-Restore/operation/get_users_and_domains_with_backup_metadata" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_users_and_domains_with_backup_metadata" id="operation/get_users_and_domains_with_backup_metadata" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-or-Restore/operation/get_users_and_domains_with_backup_metadata" aria-label="tag/Backup-or-Restore/operation/get_users_and_domains_with_backup_metadata"></a>Return users and domains with backup metadata<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists all users and their domains that have backup metadata.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all users and their domains that have backup metadata.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><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>Keys are cPanel user accounts that contain backup metadata.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Keys are cPanel user accounts that contain backup metadata.</p>
</div></div></div></td></tr><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">/get_users_and_domains_with_backup_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_users_and_domains_with_backup_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:R99d52q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d52q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d52q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d52q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d52q:0" aria-labelledby="tab:R99d52q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_users_and_domains_with_backup_metadata
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d52q:1" aria-labelledby="tab:R99d52q: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:R9pd52q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd52q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd52q:0" aria-labelledby="tab:R9pd52q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username2"</span>: <span class="token string">"example.net"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username3"</span>: <span class="token string">"example.org"</span></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">"command"</span>: <span class="token string">"get_users_and_domains_with_backup_metadata"</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/Backup-or-Restore/operation/get_users_with_backup_metadata" data-section-id="tag/Backup-or-Restore/operation/get_users_with_backup_metadata" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_users_with_backup_metadata" id="operation/get_users_with_backup_metadata" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-or-Restore/operation/get_users_with_backup_metadata" aria-label="tag/Backup-or-Restore/operation/get_users_with_backup_metadata"></a>Return users with backup metadata<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists users with backup metadata.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists users with backup metadata.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_users_with_backup_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_users_with_backup_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:R99f52q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f52q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f52q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f52q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f52q:0" aria-labelledby="tab:R99f52q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_users_with_backup_metadata
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f52q:1" aria-labelledby="tab:R99f52q: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:R9pf52q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf52q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf52q:0" aria-labelledby="tab:R9pf52q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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="array collapsible"><li><div class="hoverable "><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">"metadata"</span>: <button class="collapser" aria-label="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">"get_users_with_backup_metadata"</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/Backup-or-Restore/operation/list_cparchive_files" data-section-id="tag/Backup-or-Restore/operation/list_cparchive_files" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_cparchive_files" id="operation/list_cparchive_files" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-or-Restore/operation/list_cparchive_files" aria-label="tag/Backup-or-Restore/operation/list_cparchive_files"></a>Return cparchive files list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists all available cparchive files.</p>
<p><strong>Note:</strong></p>
<ul>
<li><code>MM.DD.YYYY</code> represents the file&#39;s date in month, date, and year format.</li>
<li><code>HH-MM-SS</code> represents the file&#39;s timestamp in hour, minute, and second format.</li>
</ul>
<p>The function checks the following filenames, where <code>USER</code> represents the cPanel account&#39;s filusername::</p>
<ul>
<li><code>cpmove-USER</code></li>
<li><code>cpmove-USER.tar</code></li>
<li><code>cpmove-USER.tar.gz</code></li>
<li><code>USER.tar</code></li>
<li><code>USER.tar.gz</code></li>
<li><code>backup-{MM.DD.YYYY}{HH-MM-SS}{USER}.tar</code></li>
<li><code>backup-{MM.DD.YYYY}{HH-MM-SS}{USER}.tar.gz</code></li>
</ul>
<p>The function checks for these filenames in the following locations:</p>
<ul>
<li><code>/home</code></li>
<li><code>/home2</code></li>
<li><code>/home3</code></li>
<li><code>/root</code></li>
<li><code>/usr</code></li>
<li><code>/usr/home</code></li>
<li><code>/web</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all available cparchive files.</p>
<p><strong>Note:</strong></p>
<ul>
<li><code>MM.DD.YYYY</code> represents the file's date in month, date, and year format.</li>
<li><code>HH-MM-SS</code> represents the file's timestamp in hour, minute, and second format.</li>
</ul>
<p>The function checks the following filenames, where <code>USER</code> represents the cPanel account's filusername::</p>
<ul>
<li><code>cpmove-USER</code></li>
<li><code>cpmove-USER.tar</code></li>
<li><code>cpmove-USER.tar.gz</code></li>
<li><code>USER.tar</code></li>
<li><code>USER.tar.gz</code></li>
<li><code>backup-{MM.DD.YYYY}{HH-MM-SS}{USER}.tar</code></li>
<li><code>backup-{MM.DD.YYYY}{HH-MM-SS}{USER}.tar.gz</code></li>
</ul>
<p>The function checks for these filenames in the following locations:</p>
<ul>
<li><code>/home</code></li>
<li><code>/home2</code></li>
<li><code>/home3</code></li>
<li><code>/root</code></li>
<li><code>/usr</code></li>
<li><code>/usr/home</code></li>
<li><code>/web</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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_cparchive_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_cparchive_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:R99h52q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h52q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h52q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h52q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h52q:0" aria-labelledby="tab:R99h52q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_cparchive_files
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h52q:1" aria-labelledby="tab:R99h52q: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:R9ph52q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph52q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph52q:0" aria-labelledby="tab:R9ph52q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"quickrestore_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">"file"</span>: <span class="token string">"cpmove-username1.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"</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></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">"command"</span>: <span class="token string">"list_cparchive_files"</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/Backup-or-Restore/operation/start_background_pkgacct" data-section-id="tag/Backup-or-Restore/operation/start_background_pkgacct" class="sc-dntaoT ceciOs"><div data-section-id="operation/start_background_pkgacct" id="operation/start_background_pkgacct" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-or-Restore/operation/start_background_pkgacct" aria-label="tag/Backup-or-Restore/operation/start_background_pkgacct"></a>Back up an account using the pkgacct script<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function backs up an account with <a href="https://go.cpanel.net/pkgacctscript">the pkgacct script</a>.</p>
<p><strong>Note:</strong></p>
<ul>
<li>The <code>/usr/local/cpanel/scripts/pkgacct</code> script logs results to the <code>/var/cpanel/pkgacct_sessions/session_id/</code> directory, where <code>session_id</code> represents the backup session&#39;s ID.</li>
<li>The target system streams the output of this function with the <code>/usr/local/cpanel/whostmgr/docroot/cgi/live_tail_log.cgi</code> script on the source system. Users should <strong>not</strong> directly call this script.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function backs up an account with <a href="https://go.cpanel.net/pkgacctscript">the pkgacct script</a>.</p>
<p><strong>Note:</strong></p>
<ul>
<li>The <code>/usr/local/cpanel/scripts/pkgacct</code> script logs results to the <code>/var/cpanel/pkgacct_sessions/session_id/</code> directory, where <code>session_id</code> represents the backup session's ID.</li>
<li>The target system streams the output of this function with the <code>/usr/local/cpanel/whostmgr/docroot/cgi/live_tail_log.cgi</code> script on the source system. Users should <strong>not</strong> directly call this script.</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="compressionsetting" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">compressionsetting</span></td><td 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"> <!-- -->Value<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"compress"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">compressionsetting=compress</span></div><div><div html="<p>Whether to compress the data in .gzip format.</p>
<ul>
<li><code>compress</code> - Compress the data.</li>
<li><code>null</code> - Do <strong>not</strong> compress the data.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to compress the data in .gzip format.</p>
<ul>
<li><code>compress</code> - Compress the data.</li>
<li><code>null</code> - Do <strong>not</strong> compress the data.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="incremental" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">incremental</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">incremental=1</span></div><div><div html="<p>Whether to update the destination file with any new content since the previous backup.
This parameter also removes any content that no longer exists on the account.
If the destination file does <strong>not</strong> exist, the function creates a new file in that location.</p>
<ul>
<li><code>1</code> — Create an incremental archive file.</li>
<li><code>0</code> — Do <strong>not</strong> create an incremental archive file.</li>
</ul>
<p><strong>Note:</strong></p>
<p> When you use this parameter, the system creates the backup as an uncompressed archive.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to update the destination file with any new content since the previous backup.
This parameter also removes any content that no longer exists on the account.
If the destination file does <strong>not</strong> exist, the function creates a new file in that location.</p>
<ul>
<li><code>1</code> — Create an incremental archive file.</li>
<li><code>0</code> — Do <strong>not</strong> create an incremental archive file.</li>
</ul>
<p><strong>Note:</strong></p>
<p> When you use this parameter, the system creates the backup as an uncompressed archive.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="low_priority" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">low_priority</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">low_priority=1</span></div><div><div html="<p>Whether to run the background task with a reduced priority.</p>
<ul>
<li><code>1</code> — Run the backup as a low priority task.</li>
<li><code>0</code> — Run the backup with normal priority.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to run the background task with a reduced priority.</p>
<ul>
<li><code>1</code> — Run the backup as a low priority task.</li>
<li><code>0</code> — Run the backup with normal priority.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="mysqlver" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mysqlver</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mysqlver=5.5</span></div><div><div html="<p>The minimum version of MySQL® that the system requires to restore the backed up database files.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can view the server&#39;s installed version of MySQL in the <code>/var/cpanel/cpanel.config</code> file.</li>
<li>This parameter defaults to the current installed version of MySQL.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The minimum version of MySQL® that the system requires to restore the backed up database files.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can view the server's installed version of MySQL in the <code>/var/cpanel/cpanel.config</code> file.</li>
<li>This parameter defaults to the current installed version of MySQL.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="serialized_output" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">serialized_output</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">serialized_output=1</span></div><div><div html="<p>Whether to encode each line of the script&#39;s output in JSON format in order to allow the <code>live_tail_log.cgi</code> script to stream it.</p>
<ul>
<li><code>1</code> — Serialize the output.</li>
<li><code>0</code> — Do <strong>not</strong> serialize the output.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to encode each line of the script's output in JSON format in order to allow the <code>live_tail_log.cgi</code> script to stream it.</p>
<ul>
<li><code>1</code> — Serialize the output.</li>
<li><code>0</code> — Do <strong>not</strong> serialize the output.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skipacctdb" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipacctdb</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">skipacctdb=1</span></div><div><div html="<p>Whether to exclude the account&#39;s databases from the cpmove archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account&#39;s databases.</li>
<li><code>0</code> — Back up the account&#39;s databases.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude the account's databases from the cpmove archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account's databases.</li>
<li><code>0</code> — Back up the account's databases.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skipapitokens" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipapitokens</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">skipapitokens=1</span></div><div><div html="<p>Whether to exclude the account&#39;s API tokens from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account&#39;s API tokens.</li>
<li><code>0</code> — Back up the account&#39;s API tokens.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude the account's API tokens from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account's API tokens.</li>
<li><code>0</code> — Back up the account's API tokens.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skipauthnlinks" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipauthnlinks</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">skipauthnlinks=1</span></div><div><div html="<p>Whether to exclude the account&#39;s external authentication credentials from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account&#39;s external authentication credentials.</li>
<li><code>0</code> — Back up the account&#39;s external authentication credentials.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude the account's external authentication credentials from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account's external authentication credentials.</li>
<li><code>0</code> — Back up the account's external authentication credentials.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skipbwdata" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipbwdata</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">skipbwdata=1</span></div><div><div html="<p>Whether to exclude the account&#39;s bandwidth data from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account&#39;s bandwidth data.</li>
<li><code>0</code> — Back up the account&#39;s data.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude the account's bandwidth data from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account's bandwidth data.</li>
<li><code>0</code> — Back up the account's data.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skipdnssec" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipdnssec</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">skipdnssec=1</span></div><div><div html="<p>Whether to exclude the account&#39;s DNSSEC configuration from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account&#39;s DNSSEC configuration.</li>
<li><code>0</code> — Back up the account&#39;s DNSSEC configuration.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude the account's DNSSEC configuration from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account's DNSSEC configuration.</li>
<li><code>0</code> — Back up the account's DNSSEC configuration.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skipdnszones" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipdnszones</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">skipdnszones=1</span></div><div><div html="<p>Whether to exclude the account&#39;s DNS zone file information from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account&#39;s DNS zone file information.</li>
<li><code>0</code> — Back up the account&#39;s DNS zone file information.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude the account's DNS zone file information from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account's DNS zone file information.</li>
<li><code>0</code> — Back up the account's DNS zone file information.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skipftpusers" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipftpusers</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">skipftpusers=1</span></div><div><div html="<p>Whether to exclude the account&#39;s FTP user accounts from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account&#39;s FTP user accounts.</li>
<li><code>0</code> — Back up the account&#39;s FTP user accounts.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude the account's FTP user accounts from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account's FTP user accounts.</li>
<li><code>0</code> — Back up the account's FTP user accounts.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skiphomedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skiphomedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">skiphomedir=1</span></div><div><div html="<p>Whether to skip the home directory&#39;s contents.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account&#39;s home directory.</li>
<li><code>0</code> — Back up the account&#39;s home directory.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip the home directory's contents.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account's home directory.</li>
<li><code>0</code> — Back up the account's home directory.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skiplinkednodes" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skiplinkednodes</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">skiplinkednodes=1</span></div><div><div html="<p>Whether to exclude the account&#39;s cPanel &amp; WHM linked server nodes configuration from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account&#39;s linked server nodes configuration.</li>
<li><code>0</code> — Back up the account&#39;s linked server nodes configuration.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude the account's cPanel & WHM linked server nodes configuration from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account's linked server nodes configuration.</li>
<li><code>0</code> — Back up the account's linked server nodes configuration.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skiplogs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skiplogs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">skiplogs=1</span></div><div><div html="<p>Whether to exclude the account&#39;s log files from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account&#39;s log files.</li>
<li><code>0</code> — Back up the account&#39;s log files.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude the account's log files from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account's log files.</li>
<li><code>0</code> — Back up the account's log files.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skipresellerconfig" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipresellerconfig</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">skipresellerconfig=1</span></div><div><div html="<p>Whether to exclude the account&#39;s reseller privileges from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account&#39;s reseller privileges.</li>
<li><code>0</code> — Back up the account&#39;s reseller privileges.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude the account's reseller privileges from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account's reseller privileges.</li>
<li><code>0</code> — Back up the account's reseller privileges.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skipshell" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipshell</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">skipshell=1</span></div><div><div html="<p>Whether to exclude the account&#39;s shell information and privileges from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account&#39;s shell information and privileges.</li>
<li><code>0</code> — Back up the account&#39;s shell information and privileges.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude the account's shell information and privileges from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account's shell information and privileges.</li>
<li><code>0</code> — Back up the account's shell information and privileges.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skipvhosttemplates" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipvhosttemplates</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">skipvhosttemplates=1</span></div><div><div html="<p>Whether to exclude the account&#39;s virtual host (vhost) templates from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account&#39;s vhost templates.</li>
<li><code>0</code> — Back up the account&#39;s vhost templates.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude the account's virtual host (vhost) templates from the archive.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> back up the account's vhost templates.</li>
<li><code>0</code> — Back up the account's vhost templates.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="split" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">split</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">split=1</span></div><div><div html="<p>Whether to create the cpmove archive in chunks.</p>
<ul>
<li><code>1</code> — Create the archive in chunks.</li>
<li><code>0</code> — Create a single archive file.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to create the cpmove archive in chunks.</p>
<ul>
<li><code>1</code> — Create the archive in chunks.</li>
<li><code>0</code> — Create a single archive file.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="tarroot" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">tarroot</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">tarroot=/home/user</span></div><div><div html="<p>The path to the directory in which you wish to store the cpmove archive.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to <code>/home/user</code>, where <code>user</code> represents the username of the account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The path to the directory in which you wish to store the cpmove archive.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to <code>/home/user</code>, where <code>user</code> represents the username of the account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="use_backups" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">use_backups</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">use_backups=1</span></div><div><div html="<p>Whether to use the account&#39;s last known successful backup as a template when the script creates the cpmove archive, if any exist.</p>
<ul>
<li><code>1</code> — Use the account&#39;s last known successful backup as a template, if any exist.</li>
<li><code>0</code> — Do <strong>not</strong> use the account&#39;s last known successful backup.</li>
</ul>
<p><strong>Note:</strong></p>
<p> This parameter may reduce the amount of time that the backup process requires.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use the account's last known successful backup as a template when the script creates the cpmove archive, if any exist.</p>
<ul>
<li><code>1</code> — Use the account's last known successful backup as a template, if any exist.</li>
<li><code>0</code> — Do <strong>not</strong> use the account's last known successful backup.</li>
</ul>
<p><strong>Note:</strong></p>
<p> This parameter may reduce the amount of time that the backup process requires.</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=username</span></div><div><div html="<p>The cPanel account to back up.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account to back up.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/start_background_pkgacct</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/start_background_pkgacct</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99j52q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j52q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j52q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j52q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j52q:0" aria-labelledby="tab:R99j52q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
start_background_pkgacct <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R99j52q:1" aria-labelledby="tab:R99j52q: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:R9pj52q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj52q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj52q:0" aria-labelledby="tab:R9pj52q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"complete_master_error_log"</span>: <span class="token string">"master.error_log"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"complete_master_log"</span>: <span class="token string">"master.log"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"session_id"</span>: <span class="token string">"example20151109162046c4xzDp55q9u4tPj"</span></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">"command"</span>: <span class="token string">"start_background_pkgacct"</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/Backup-or-Restore/operation/backup_get_transport_status" data-section-id="tag/Backup-or-Restore/operation/backup_get_transport_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_get_transport_status" id="operation/backup_get_transport_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-or-Restore/operation/backup_get_transport_status" aria-label="tag/Backup-or-Restore/operation/backup_get_transport_status"></a>Return backup transport events' status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the status of any backup transport events on the account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the status of any backup transport events 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=""><td kind="field" title="state" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">state</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"completed"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"failed"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"pending"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"running"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">state=running</span></div><div><div html="<p>That transport&#39;s current state. If you do <strong>not</strong> specify this parameter,
the function returns the status of <strong>all</strong> transports on the account.</p>
<ul>
<li><code>completed</code></li>
<li><code>failed</code></li>
<li><code>pending</code></li>
<li><code>running</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>That transport's current state. If you do <strong>not</strong> specify this parameter,
the function returns the status of <strong>all</strong> transports on the account.</p>
<ul>
<li><code>completed</code></li>
<li><code>failed</code></li>
<li><code>pending</code></li>
<li><code>running</code></li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="transport_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">transport_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">transport_id=transportname</span></div><div><div html="<p>The transport&#39;s identification (ID). If you do <strong>not</strong> specify this parameter,
the function returns <strong>all</strong> transports on the account.</p>
<p><strong>Note:</strong></p>
<p>You can use this parameter or the <code>transport_name</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The transport's identification (ID). If you do <strong>not</strong> specify this parameter,
the function returns <strong>all</strong> transports on the account.</p>
<p><strong>Note:</strong></p>
<p>You can use this parameter or the <code>transport_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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/backup_get_transport_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_get_transport_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:R99l52q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99l52q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99l52q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l52q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99l52q:0" aria-labelledby="tab:R99l52q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_get_transport_status
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l52q:1" aria-labelledby="tab:R99l52q: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:R9pl52q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pl52q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pl52q:0" aria-labelledby="tab:R9pl52q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"pages"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"transport_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 "><button class="collapser" aria-label="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">"2019-08-30T00:00:00.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"end_timestamp"</span>: <span class="token string">"2019-08-30T02:04:06.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_timestamp"</span>: <span class="token string">"2019-08-30T02:04:08.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"running"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"transport"</span>: <span class="token string">"transportname"</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></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">"command"</span>: <span class="token string">"backup_get_transport_status"</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/Backup-or-Restore/operation/start_local_cpmove_restore" data-section-id="tag/Backup-or-Restore/operation/start_local_cpmove_restore" class="sc-dntaoT ceciOs"><div data-section-id="operation/start_local_cpmove_restore" id="operation/start_local_cpmove_restore" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-or-Restore/operation/start_local_cpmove_restore" aria-label="tag/Backup-or-Restore/operation/start_local_cpmove_restore"></a>Restore one cPanel account from a backup<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function performs a full restoration of a single cPanel account from a <code>cpmove</code> tarball.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function performs a full restoration of a single cPanel account from a <code>cpmove</code> tarball.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="cpmovepath" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpmovepath</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cpmovepath=/home/cpmove-newacct.tar.gz</span></div><div><div html="<p>A filepath that contains the account&#39;s <code>cpmove</code> tarball or the directory path that contains the extracted <code>cpmove</code> tarball.</p>
<p> <strong>Note:</strong></p>
<p>You can use the <a href="https://go.cpanel.net/ThepkgacctScript">pkgacct script</a> to create a <code>cpmove</code> tarball.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A filepath that contains the account's <code>cpmove</code> tarball or the directory path that contains the extracted <code>cpmove</code> tarball.</p>
<p> <strong>Note:</strong></p>
<p>You can use the <a href="https://go.cpanel.net/ThepkgacctScript">pkgacct script</a> to create a <code>cpmove</code> tarball.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="dedicated_ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dedicated_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">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">dedicated_ip=0</span></div><div><div html="<p>Whether to assign the account a dedicated IP address.</p>
<ul>
<li><p><code>1</code> - Assign a dedicated IP address.</p>
</li>
<li><p><code>0</code> - Do <strong>not</strong> assign a dedicated IP address.</p>
<p><strong>Note:</strong></p>
</li>
</ul>
<p>The system <strong>must</strong> have an available IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to assign the account a dedicated IP address.</p>
<ul>
<li><p><code>1</code> - Assign a dedicated IP address.</p>
</li>
<li><p><code>0</code> - Do <strong>not</strong> assign a dedicated IP address.</p>
<p><strong>Note:</strong></p>
</li>
</ul>
<p>The system <strong>must</strong> have an available IP address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="delete_archive" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delete_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"> <!-- -->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">delete_archive=0</span></div><div><div html="<p>Whether to delete the <code>cpmove</code> tarball or extracted directory, given in the <code>cpmovepath</code> parameter, after the system completes the account restoration.</p>
<ul>
<li><code>1</code> - Delete the <code>cpmove</code> tarball or extracted directory.</li>
<li><code>0</code> - Do <strong>not</strong> delete the <code>cpmove</code> tarball or extracted directory.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to delete the <code>cpmove</code> tarball or extracted directory, given in the <code>cpmovepath</code> parameter, after the system completes the account restoration.</p>
<ul>
<li><code>1</code> - Delete the <code>cpmove</code> tarball or extracted directory.</li>
<li><code>0</code> - Do <strong>not</strong> delete the <code>cpmove</code> tarball or extracted directory.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="mail_location" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand mail_location"><span class="property-name">mail_location</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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">".existing"</span></div> <div><div html="<p>The server on which the account&#39;s email will reside after the system completes the transfer.</p>
<ul>
<li><code>.local</code> - Use the local server the account is being restored on.</li>
<li><code>.existing</code> - Use the server location defined in the account&#39;s backup data. The system defaults to the <code>.local</code> parameter if this does <strong>not</strong> work.</li>
<li><code>ALIAS</code> - Use a <a href="https://go.cpanel.net/whmlinkednodes">cPanel &amp; WHM linked node server&#39;s alias</a>. For example, the <code>example-alias</code> for the <code>servernode.example.com</code> domain. The system defaults to the <code>.local</code> parameter if this does <strong>not</strong> work.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server on which the account's email will reside after the system completes the transfer.</p>
<ul>
<li><code>.local</code> - Use the local server the account is being restored on.</li>
<li><code>.existing</code> - Use the server location defined in the account's backup data. The system defaults to the <code>.local</code> parameter if this does <strong>not</strong> work.</li>
<li><code>ALIAS</code> - Use a <a href="https://go.cpanel.net/whmlinkednodes">cPanel & WHM linked node server's alias</a>. For example, the <code>example-alias</code> for the <code>servernode.example.com</code> domain. The system defaults to the <code>.local</code> parameter if this does <strong>not</strong> work.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">overwrite=1</span></div><div><div html="<p>Whether to overwrite an existing account on the server, if one exists.</p>
<ul>
<li><code>1</code> - Overwrite an existing account.</li>
<li><code>0</code> - Do <strong>not</strong> overwrite an existing account on the server.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to overwrite an existing account on the server, if one exists.</p>
<ul>
<li><code>1</code> - Overwrite an existing account.</li>
<li><code>0</code> - Do <strong>not</strong> overwrite an existing account on the server.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="restricted" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">restricted</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">restricted=0</span></div><div><div html="<p>Whether to perform a restricted restore for the account. The system will perform security checks on the backup file. If you do not trust the source of the account backup with <code>root</code> access to your server, use this parameter to protect your server.</p>
<ul>
<li><code>1</code> - Perform a restricted restore.</li>
<li><code>0</code> - Do <strong>not</strong> perform a restricted restore.</li>
</ul>
<p><strong>Important:</strong></p>
<ul>
<li>This parameter is <strong>experimental</strong>. Do <strong>not</strong> consider it as an effective security control. For more information, read our <a href="https://go.cpanel.net/whmdocsTransferorRestoreacPanelAccount#restricted-restore">restricted restore</a> documentation.</li>
<li>If the account owns PostgreSQL® databases, your server <strong>must</strong> use PostgreSQL version 8.4 or newer.</li>
<li>This parameter <strong>only</strong> allows restored accounts to use the <code>noshell</code> or <a href="https://go.cpanel.net/VirtFSJailedShell"><code>jailshell</code></a> environments. If the account uses a different shell, the system will set the account to use the <code>noshell</code> environment.</li>
<li>If there is an issue with the backup file, the system will <strong>not</strong> restore that part of the backup file. It will also adds a warning to the log file.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to perform a restricted restore for the account. The system will perform security checks on the backup file. If you do not trust the source of the account backup with <code>root</code> access to your server, use this parameter to protect your server.</p>
<ul>
<li><code>1</code> - Perform a restricted restore.</li>
<li><code>0</code> - Do <strong>not</strong> perform a restricted restore.</li>
</ul>
<p><strong>Important:</strong></p>
<ul>
<li>This parameter is <strong>experimental</strong>. Do <strong>not</strong> consider it as an effective security control. For more information, read our <a href="https://go.cpanel.net/whmdocsTransferorRestoreacPanelAccount#restricted-restore">restricted restore</a> documentation.</li>
<li>If the account owns PostgreSQL® databases, your server <strong>must</strong> use PostgreSQL version 8.4 or newer.</li>
<li>This parameter <strong>only</strong> allows restored accounts to use the <code>noshell</code> or <a href="https://go.cpanel.net/VirtFSJailedShell"><code>jailshell</code></a> environments. If the account uses a different shell, the system will set the account to use the <code>noshell</code> environment.</li>
<li>If there is an issue with the backup file, the system will <strong>not</strong> restore that part of the backup file. It will also adds a warning to the log file.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="update_a_records" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">update_a_records</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"all"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"basic"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">update_a_records=all</span></div><div><div html="<p>Whether to perform one of the following actions to the account&#39;s A records:</p>
<ul>
<li><code>all</code> - Replace <strong>all</strong> instances of the original server&#39;s IP address with the new server&#39;s IP address.</li>
<li><code>basic</code> - <strong>Only</strong> replace the cPanel provided A records.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to perform one of the following actions to the account's A records:</p>
<ul>
<li><code>all</code> - Replace <strong>all</strong> instances of the original server's IP address with the new server's IP address.</li>
<li><code>basic</code> - <strong>Only</strong> replace the cPanel provided A records.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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 to give to the restored cPanel account. This will default to the username provided in the backup files.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username to give to the restored cPanel account. This will default to the username provided in the backup 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/start_local_cpmove_restore</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/start_local_cpmove_restore</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99n52q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99n52q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99n52q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n52q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99n52q:0" aria-labelledby="tab:R99n52q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
start_local_cpmove_restore <span class="token punctuation">\</span>
<span class="token assign-left variable">cpmovepath</span><span class="token operator">=</span><span class="token string">'/home/cpmove-newacct.tar.gz'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99n52q:1" aria-labelledby="tab:R99n52q: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:R9pn52q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pn52q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pn52q:0" aria-labelledby="tab:R9pn52q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transfer_session_id"</span>: <span class="token string">"example202003301756425ugO"</span></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">"command"</span>: <span class="token string">"start_local_cpmove_restore"</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/Backup-Settings" data-section-id="tag/Backup-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/Backup-Settings" aria-label="tag/Backup-Settings"></a>Backup Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Backups / Backup Settings</p>
"><p>Backups / Backup Settings</p>
</div></div></div><div id="tag/Backup-Settings/operation/backup_config_set" data-section-id="tag/Backup-Settings/operation/backup_config_set" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_config_set" id="operation/backup_config_set" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Settings/operation/backup_config_set" aria-label="tag/Backup-Settings/operation/backup_config_set"></a>Update the system's backup configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function configures a server&#39;s backup system. The system saves these settings in the <code>/var/cpanel/backups/config</code> file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function configures a server's backup system. The system saves these settings in the <code>/var/cpanel/backups/config</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="backup_daily_enable" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup_daily_enable</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">backup_daily_enable=1</span></div><div><div html="<p>Whether to enable daily backups.</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 daily backups.</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="backup_daily_retention" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup_daily_retention</span></td><td class="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">5</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backup_daily_retention=5</span></div><div><div html="<p>The number of daily backups to retain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of daily backups to retain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="backup_monthly_dates" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup_monthly_dates</span></td><td class="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 .. 31 ]<!-- --> </span></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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backup_monthly_dates=1</span></div><div><div html="<p>Which days of the month to run backups.</p>
<p><strong>Note:</strong></p>
<p>To add multiple days, use a comma-delimited list.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Which days of the month to run backups.</p>
<p><strong>Note:</strong></p>
<p>To add multiple days, use a comma-delimited list.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="backup_monthly_enable" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup_monthly_enable</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">backup_monthly_enable=0</span></div><div><div html="<p>Whether to enable monthly backups.</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 monthly backups.</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="backup_monthly_retention" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup_monthly_retention</span></td><td class="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">1</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backup_monthly_retention=5</span></div><div><div html="<p>The number of monthly backups to retain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of monthly backups to retain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="backup_weekly_day" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup_weekly_day</span></td><td class="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 .. 6 ]<!-- --> </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">backup_weekly_day=1</span></div><div><div html="<p>Which day of the week to run weekly backups.</p>
<ul>
<li><code>0</code> — Sunday.</li>
<li><code>1</code> — Monday.</li>
<li><code>2</code> — Tuesday.</li>
<li><code>3</code> — Wednesday.</li>
<li><code>4</code> — Thursday.</li>
<li><code>5</code> — Friday.</li>
<li><code>6</code> — Saturday.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Which day of the week to run weekly backups.</p>
<ul>
<li><code>0</code> — Sunday.</li>
<li><code>1</code> — Monday.</li>
<li><code>2</code> — Tuesday.</li>
<li><code>3</code> — Wednesday.</li>
<li><code>4</code> — Thursday.</li>
<li><code>5</code> — Friday.</li>
<li><code>6</code> — Saturday.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="backup_weekly_enable" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup_weekly_enable</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">backup_weekly_enable=0</span></div><div><div html="<p>Whether to enable weekly backups.</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 weekly backups.</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="backup_weekly_retention" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup_weekly_retention</span></td><td class="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">4</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backup_weekly_retention=4</span></div><div><div html="<p>The number of weekly backups to retain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of weekly backups to retain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="backupaccts" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backupaccts</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">backupaccts=1</span></div><div><div html="<p>Whether to back up cPanel user accounts.</p>
<ul>
<li><code>1</code> — Back up.</li>
<li><code>0</code> — Do <strong>not</strong> back up.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This setting affects whether the system enables the <em>File and Directory Restoration</em>
interfaces in
<a href="https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/">cPanel</a>
and in
<a href="https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/">WHM</a>.
For more information, read the
<a href="https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/">How to Manage Metadata Settings</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to back up cPanel user accounts.</p>
<ul>
<li><code>1</code> — Back up.</li>
<li><code>0</code> — Do <strong>not</strong> back up.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This setting affects whether the system enables the <em>File and Directory Restoration</em>
interfaces in
<a href="https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/">cPanel</a>
and in
<a href="https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/">WHM</a>.
For more information, read the
<a href="https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/">How to Manage Metadata Settings</a>
documentation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="backupbwdata" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backupbwdata</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">backupbwdata=1</span></div><div><div html="<p>Whether to back up bandwidth tracking data.</p>
<ul>
<li><code>1</code> — Back up.</li>
<li><code>0</code> — Do <strong>not</strong> back up.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to back up bandwidth tracking data.</p>
<ul>
<li><code>1</code> — Back up.</li>
<li><code>0</code> — Do <strong>not</strong> back up.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="backupdays" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backupdays</span></td><td class="sc-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"> <!-- -->[ 0 .. 6 ]<!-- --> </span></span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"0,2,4,6"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backupdays=0,1,2,3,4,5,6</span></div><div><div html="<p>Which days of the week to run daily backups.</p>
<ul>
<li><code>0</code> — Sunday.</li>
<li><code>1</code> — Monday.</li>
<li><code>2</code> — Tuesday.</li>
<li><code>3</code> — Wednesday.</li>
<li><code>4</code> — Thursday.</li>
<li><code>5</code> — Friday.</li>
<li><code>6</code> — Saturday.</li>
</ul>
<p><strong>Note:</strong></p>
<p>For multiple days, use a comma-delimited list.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Which days of the week to run daily backups.</p>
<ul>
<li><code>0</code> — Sunday.</li>
<li><code>1</code> — Monday.</li>
<li><code>2</code> — Tuesday.</li>
<li><code>3</code> — Wednesday.</li>
<li><code>4</code> — Thursday.</li>
<li><code>5</code> — Friday.</li>
<li><code>6</code> — Saturday.</li>
</ul>
<p><strong>Note:</strong></p>
<p>For multiple days, use a comma-delimited list.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="backupdir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backupdir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"/backup"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backupdir=/backup</span></div><div><div html="<p>The primary backup directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The primary backup directory.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="backupenable" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backupenable</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">backupenable=0</span></div><div><div html="<p>Whether to enable backups.</p>
<ul>
<li><code>1</code> — Enable.</li>
<li><code>0</code> — Disable.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This setting affects whether the system enables the <em>File and Directory Restoration</em>
interfaces in
<a href="https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/">cPanel</a>
and in
<a href="https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/">WHM</a>.
For more information, read the
<a href="https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/">How to Manage Metadata Settings</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable backups.</p>
<ul>
<li><code>1</code> — Enable.</li>
<li><code>0</code> — Disable.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This setting affects whether the system enables the <em>File and Directory Restoration</em>
interfaces in
<a href="https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/">cPanel</a>
and in
<a href="https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/">WHM</a>.
For more information, read the
<a href="https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/">How to Manage Metadata Settings</a>
documentation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="backupfiles" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backupfiles</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">backupfiles=1</span></div><div><div html="<p>Whether to back up system files.</p>
<ul>
<li><code>1</code> — Back up.</li>
<li><code>0</code> — Do <strong>not</strong> back up.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to back up system files.</p>
<ul>
<li><code>1</code> — Back up.</li>
<li><code>0</code> — Do <strong>not</strong> back up.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="backuplogs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backuplogs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">backuplogs=0</span></div><div><div html="<p>Whether to back up the error logs.</p>
<ul>
<li><code>1</code> — Back up.</li>
<li><code>0</code> — Do <strong>not</strong> back up.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to back up the error logs.</p>
<ul>
<li><code>1</code> — Back up.</li>
<li><code>0</code> — Do <strong>not</strong> back up.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="backupmount" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backupmount</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">backupmount=0</span></div><div><div html="<p>Whether to mount a backup partition.</p>
<ul>
<li><code>1</code> — Mount.</li>
<li><code>0</code> — Do <strong>not</strong> mount.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This setting affects whether the system enables the <em>File and Directory Restoration</em>
interfaces in
<a href="https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/">cPanel</a>
and in
<a href="https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/">WHM</a>.
For more information, read the
<a href="https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/">How to Manage Metadata Settings</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to mount a backup partition.</p>
<ul>
<li><code>1</code> — Mount.</li>
<li><code>0</code> — Do <strong>not</strong> mount.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This setting affects whether the system enables the <em>File and Directory Restoration</em>
interfaces in
<a href="https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/">cPanel</a>
and in
<a href="https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/">WHM</a>.
For more information, read the
<a href="https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/">How to Manage Metadata Settings</a>
documentation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="backupsuspendedaccts" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backupsuspendedaccts</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">backupsuspendedaccts=0</span></div><div><div html="<p>Whether to back up suspended accounts.</p>
<ul>
<li><code>1</code> — Back up.</li>
<li><code>0</code> — Do <strong>not</strong> back up.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to back up suspended accounts.</p>
<ul>
<li><code>1</code> — Back up.</li>
<li><code>0</code> — Do <strong>not</strong> back up.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="backuptype" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backuptype</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"compressed"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"compressed"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"uncompressed"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"incremental"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backuptype=compressed</span></div><div><div html="<p>The type of backup to create.</p>
<ul>
<li><code>compressed</code></li>
<li><code>uncompressed</code></li>
<li><code>incremental</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of backup to create.</p>
<ul>
<li><code>compressed</code></li>
<li><code>uncompressed</code></li>
<li><code>incremental</code></li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="check_min_free_space" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">check_min_free_space</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">check_min_free_space=1</span></div><div><div html="<p>Whether to ensure that the destination server possesses the minimum
free disk space available.</p>
<ul>
<li><code>1</code> — Check the free disk space on the destination server.</li>
<li><code>0</code> — Do <strong>not</strong> check the free disk space on the destination server.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to ensure that the destination server possesses the minimum
free disk space available.</p>
<ul>
<li><code>1</code> — Check the free disk space on the destination server.</li>
<li><code>0</code> — Do <strong>not</strong> check the free disk space on the destination server.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="disable_metadata" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">disable_metadata</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">disable_metadata=0</span></div><div><div html="<p>Whether the backup system will create metadata when a backup runs.</p>
<ul>
<li><code>1</code> — Disable metadata creation.</li>
<li><code>0</code> — Enable metadata creation.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This setting affects whether the system enables the <em>File and Directory Restoration</em>
interfaces in
<a href="https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/">cPanel</a>
and in
<a href="https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/">WHM</a>.
For more information, read the
<a href="https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/">How to Manage Metadata Settings</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the backup system will create metadata when a backup runs.</p>
<ul>
<li><code>1</code> — Disable metadata creation.</li>
<li><code>0</code> — Enable metadata creation.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This setting affects whether the system enables the <em>File and Directory Restoration</em>
interfaces in
<a href="https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/">cPanel</a>
and in
<a href="https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/">WHM</a>.
For more information, read the
<a href="https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/">How to Manage Metadata Settings</a>
documentation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="errorthreshhold" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">errorthreshhold</span></td><td class="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">3</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">errorthreshhold=3</span></div><div><div html="<p>The number of times that the system will try to use the additional backup destination.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of times that the system will try to use the additional backup destination.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="force_prune_daily" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">force_prune_daily</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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_prune_daily=0</span></div><div><div html="<p>Whether to strictly enforce the value of the <code>backup_daily_retention</code>
parameter.</p>
<ul>
<li><code>1</code> — Strictly enforce the <code>backup_daily_retention</code> parameter.</li>
<li><code>0</code> — Only enforce the <code>backup_daily_retention</code> parameter <strong>after</strong> a
successful complete backup.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to strictly enforce the value of the <code>backup_daily_retention</code>
parameter.</p>
<ul>
<li><code>1</code> — Strictly enforce the <code>backup_daily_retention</code> parameter.</li>
<li><code>0</code> — Only enforce the <code>backup_daily_retention</code> parameter <strong>after</strong> a
successful complete backup.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="force_prune_monthly" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">force_prune_monthly</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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_prune_monthly=0</span></div><div><div html="<p>Whether to strictly enforce the value of the <code>backup_monthly_retention</code>
parameter.</p>
<ul>
<li><code>1</code> — Strictly enforce the <code>backup_monthly_retention</code> parameter.</li>
<li><code>0</code> — Only enforce the <code>backup_monthly_retention</code> parameter <strong>after</strong> a
successful complete backup.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to strictly enforce the value of the <code>backup_monthly_retention</code>
parameter.</p>
<ul>
<li><code>1</code> — Strictly enforce the <code>backup_monthly_retention</code> parameter.</li>
<li><code>0</code> — Only enforce the <code>backup_monthly_retention</code> parameter <strong>after</strong> a
successful complete backup.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="force_prune_weekly" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">force_prune_weekly</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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_prune_weekly=0</span></div><div><div html="<p>Whether to strictly enforce the value of the <code>backup_weekly_retention</code>
parameter.</p>
<ul>
<li><code>1</code> — Strictly enforce the <code>backup_weekly_retention</code> parameter.</li>
<li><code>0</code> — Only enforce the <code>backup_weekly_retention</code> parameter <strong>after</strong> a
successful complete backup.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to strictly enforce the value of the <code>backup_weekly_retention</code>
parameter.</p>
<ul>
<li><code>1</code> — Strictly enforce the <code>backup_weekly_retention</code> parameter.</li>
<li><code>0</code> — Only enforce the <code>backup_weekly_retention</code> parameter <strong>after</strong> a
successful complete backup.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="gziprsyncopts" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">gziprsyncopts</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">gziprsyncopts=--rysncable</span></div><div><div html="<p>The <code>gzip</code> environment variables.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <code>gzip</code> environment variables.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="keeplocal" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">keeplocal</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">keeplocal=1</span></div><div><div html="<p>Whether to delete backups from the local directory.</p>
<ul>
<li><code>1</code> — Delete.</li>
<li><code>0</code> — Do <strong>not</strong> delete.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This setting affects whether the system enables the <em>File and Directory Restoration</em>
interfaces in
<a href="https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/">cPanel</a>
and in
<a href="https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/">WHM</a>.
For more information, read the
<a href="https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/">How to Manage Metadata Settings</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to delete backups from the local directory.</p>
<ul>
<li><code>1</code> — Delete.</li>
<li><code>0</code> — Do <strong>not</strong> delete.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This setting affects whether the system enables the <em>File and Directory Restoration</em>
interfaces in
<a href="https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/">cPanel</a>
and in
<a href="https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/">WHM</a>.
For more information, read the
<a href="https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/">How to Manage Metadata Settings</a>
documentation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="linkdest" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">linkdest</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">linkdest=0</span></div><div><div html="<p>Whether to check the <code>rsync</code> function for hardlink support.</p>
<ul>
<li><code>1</code> — Check.</li>
<li><code>0</code> — Do <strong>not</strong> check.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to check the <code>rsync</code> function for hardlink support.</p>
<ul>
<li><code>1</code> — Check.</li>
<li><code>0</code> — Do <strong>not</strong> check.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="localzonesonly" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">localzonesonly</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">localzonesonly=0</span></div><div><div html="<p>Whether to use a local zone file from the <code>/var/named/domain.tld</code>
file or the <code>dnsadmin</code> daemon, where <code>domain.tld</code> represents the target domain.</p>
<ul>
<li><code>1</code> — Use the <code>/var/named/domain.tld</code> file.</li>
<li><code>0</code> — Use <code>dnsadmin</code>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use a local zone file from the <code>/var/named/domain.tld</code>
file or the <code>dnsadmin</code> daemon, where <code>domain.tld</code> represents the target domain.</p>
<ul>
<li><code>1</code> — Use the <code>/var/named/domain.tld</code> file.</li>
<li><code>0</code> — Use <code>dnsadmin</code>.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maximum_restore_timeout" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">maximum_restore_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">21600</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">maximum_restore_timeout=21600</span></div><div><div html="<p>How long a restoration will attempt to run, in seconds. If the restoration does not succeed in this amount of time, it will stop.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>How long a restoration will attempt to run, in seconds. If the restoration does not succeed in this amount of time, it will stop.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="maximum_timeout" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">maximum_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">maximum_timeout=7200</span></div><div><div html="<p>How long a backup will attempt to run, in seconds. If the backup does not succeed in this amount of time, it will stop.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>How long a backup will attempt to run, in seconds. If the backup does not succeed in this amount of time, it will stop.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="min_free_space" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">min_free_space</span></td><td class="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">5</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">min_free_space=1024</span></div><div><div html="<p>The minimum amount of free disk to check for on the destination server.</p>
<p><strong>Note:</strong></p>
<p>If the value of the <code>min_free_space_unit</code> parameter is <code>percent</code>, the maximum
value is <code>100</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The minimum amount of free disk to check for on the destination server.</p>
<p><strong>Note:</strong></p>
<p>If the value of the <code>min_free_space_unit</code> parameter is <code>percent</code>, the maximum
value is <code>100</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="min_free_space_unit" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">min_free_space_unit</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"percent"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"MB"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"percent"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">min_free_space_unit=MB</span></div><div><div html="<p>The units of measurement of disk space for the <code>min_free_space</code> return.</p>
<ul>
<li><code>MB</code> — Megabytes.</li>
<li><code>percent</code> — Percent available.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The units of measurement of disk space for the <code>min_free_space</code> return.</p>
<ul>
<li><code>MB</code> — Megabytes.</li>
<li><code>percent</code> — Percent available.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="mysqlbackup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mysqlbackup</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"accounts"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"accounts"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"dir"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"both"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mysqlbackup=accounts</span></div><div><div html="<p>The backup method to use for MySQL® databases.</p>
<ul>
<li><code>accounts</code> — Back up databases in each account&#39;s archive.</li>
<li><code>dir</code> — Back up the entire MySQL directory.</li>
<li><code>both</code> — Back up databases in each account&#39;s archive and the entire
MySQL directory.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The backup method to use for MySQL® databases.</p>
<ul>
<li><code>accounts</code> — Back up databases in each account's archive.</li>
<li><code>dir</code> — Back up the entire MySQL directory.</li>
<li><code>both</code> — Back up databases in each account's archive and the entire
MySQL directory.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="postbackup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">postbackup</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">postbackup=0</span></div><div><div html="<p>Whether to run the <code>/usr/local/cpanel/scripts/postcpbackup</code> script after
the backup finishes.</p>
<ul>
<li><code>1</code> — Run.</li>
<li><code>0</code> — Do <strong>not</strong> run.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to run the <code>/usr/local/cpanel/scripts/postcpbackup</code> script after
the backup finishes.</p>
<ul>
<li><code>1</code> — Run.</li>
<li><code>0</code> — Do <strong>not</strong> run.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="prebackup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">prebackup</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">prebackup=1</span></div><div><div html="<p>Whether to run the <code>/usr/local/cpanel/scripts/precpbackup</code> script before
the system processes backups.</p>
<ul>
<li><code>1</code> — Run.</li>
<li><code>0</code> — Do <strong>not</strong> run.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to run the <code>/usr/local/cpanel/scripts/precpbackup</code> script before
the system processes backups.</p>
<ul>
<li><code>1</code> — Run.</li>
<li><code>0</code> — Do <strong>not</strong> run.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="psqlbackup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">psqlbackup</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">psqlbackup=0</span></div><div><div html="<p>Whether to back up PostgreSQL® databases.</p>
<ul>
<li><code>1</code> — Back up.</li>
<li><code>0</code> — Do <strong>not</strong> back up.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to back up PostgreSQL® databases.</p>
<ul>
<li><code>1</code> — Back up.</li>
<li><code>0</code> — Do <strong>not</strong> back up.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="remote_restore_staging_dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">remote_restore_staging_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">remote_restore_staging_dir=/backup</span></div><div><div html="<p>The directory that temporarily stores a remote backup&#39;s data during a backup restoration.
The data is a compressed (<code>.tar.gz</code>) or uncompressed (<code>.tar</code>) account tarball.</p>
<p><strong>Important:</strong></p>
<p>The system restores backups one at a time. The backup staging directory <strong>must</strong>
be large enough to contain the largest remote backup file that you wish to restore.
For example, if you wish to restore three backups, sized 1.5 GB, 528 MB, and
950 MB each, your backup staging directory must be able to hold at <strong>least</strong> 1.5 GB.</p>
<p><strong>Note:</strong></p>
<p>The system empties the directory after the system restores the backup.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory that temporarily stores a remote backup's data during a backup restoration.
The data is a compressed (<code>.tar.gz</code>) or uncompressed (<code>.tar</code>) account tarball.</p>
<p><strong>Important:</strong></p>
<p>The system restores backups one at a time. The backup staging directory <strong>must</strong>
be large enough to contain the largest remote backup file that you wish to restore.
For example, if you wish to restore three backups, sized 1.5 GB, 528 MB, and
950 MB each, your backup staging directory must be able to hold at <strong>least</strong> 1.5 GB.</p>
<p><strong>Note:</strong></p>
<p>The system empties the directory after the system restores the backup.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/backup_config_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_config_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:R4kj72q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj72q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj72q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj72q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj72q:0" aria-labelledby="tab:R4kj72q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_config_set
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj72q:1" aria-labelledby="tab:R4kj72q: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:R4sj72q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj72q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj72q:0" aria-labelledby="tab:R4sj72q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"backup_config_set"</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/Backup-Settings/operation/backup_date_list" data-section-id="tag/Backup-Settings/operation/backup_date_list" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_date_list" id="operation/backup_date_list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Settings/operation/backup_date_list" aria-label="tag/Backup-Settings/operation/backup_date_list"></a>Return dates where backup files exist<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the dates where backup file exists, whether stored locally or stored on remote backup destinations when local backups are disabled.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the dates where backup file exists, whether stored locally or stored on remote backup destinations when local backups are 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/backup_date_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_date_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:R4kl72q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl72q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl72q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl72q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl72q:0" aria-labelledby="tab:R4kl72q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_date_list
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl72q:1" aria-labelledby="tab:R4kl72q: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:R4sl72q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl72q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl72q:0" aria-labelledby="tab:R4sl72q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_set"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"2019-02-12T00:00:00.000Z"</span>,</div></li><li><div class="hoverable "><span class="token string">"2019-02-12T00:00:00.000Z"</span>,</div></li><li><div class="hoverable "><span class="token string">"2019-02-12T00:00:00.000Z"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"backup_date_list"</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/Backup-Settings/operation/backup_skip_users_all" data-section-id="tag/Backup-Settings/operation/backup_skip_users_all" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_skip_users_all" id="operation/backup_skip_users_all" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Settings/operation/backup_skip_users_all" aria-label="tag/Backup-Settings/operation/backup_skip_users_all"></a>Enable or disable backups<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables and disables the backup and legacy backups.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables and disables the backup and legacy backups.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="backupversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backupversion</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"backup"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"legacy"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backupversion=backup</span></div><div><div html="<p>The type of backup.</p>
<ul>
<li><code>backup</code> - Standard backups.</li>
<li><code>legacy</code> - Legacy backups.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of backup.</p>
<ul>
<li><code>backup</code> - Standard backups.</li>
<li><code>legacy</code> - Legacy backups.</li>
</ul>
</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 the backup type that the <code>backupversion</code> parameter
specifies for all users.</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 the backup type that the <code>backupversion</code> parameter
specifies for all users.</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="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">/backup_skip_users_all</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_skip_users_all</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn72q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn72q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn72q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn72q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn72q:0" aria-labelledby="tab:R4kn72q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_skip_users_all <span class="token punctuation">\</span>
<span class="token assign-left variable">state</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">backupversion</span><span class="token operator">=</span><span class="token string">'backup'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn72q:1" aria-labelledby="tab:R4kn72q: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:R4sn72q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn72q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn72q:0" aria-labelledby="tab:R4sn72q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"backup_skip_users_all"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Configuration update process started"</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/Backup-Settings/operation/backup_skip_users_all_status" data-section-id="tag/Backup-Settings/operation/backup_skip_users_all_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_skip_users_all_status" id="operation/backup_skip_users_all_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Settings/operation/backup_skip_users_all_status" aria-label="tag/Backup-Settings/operation/backup_skip_users_all_status"></a>Return backup configuration status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks each user&#39;s backup configuration status while the <code>backup_skip_users_all</code> function runs.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks each user's backup configuration status while the <code>backup_skip_users_all</code> function runs.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/backup_skip_users_all_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_skip_users_all_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:R4kp72q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp72q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp72q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp72q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp72q:0" aria-labelledby="tab:R4kp72q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_skip_users_all_status
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp72q:1" aria-labelledby="tab:R4kp72q: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:R4sp72q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp72q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp72q:0" aria-labelledby="tab:R4sp72q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="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"</span>: <span class="token string">"Done"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perc"</span>: <span class="token number">100</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"running"</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">"metadata"</span>: <button class="collapser" aria-label="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">"backup_skip_users_all_status"</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/Backup-Settings/operation/backup_user_list" data-section-id="tag/Backup-Settings/operation/backup_user_list" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_user_list" id="operation/backup_user_list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Settings/operation/backup_user_list" aria-label="tag/Backup-Settings/operation/backup_user_list"></a>Return users with a backup file<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists users with a backup file, stored locally or on additional backup destinations, on a specified date.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists users with a backup file, stored locally or on additional backup destinations, on a specified date.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="restore_point" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">restore_point</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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-8601 Date<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">restore_point=2014-10-10T00:00:00.000Z</span></div><div><div html="<p>The desired date.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The desired date.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/backup_user_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_user_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:R4kr72q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr72q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr72q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr72q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr72q:0" aria-labelledby="tab:R4kr72q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_user_list <span class="token punctuation">\</span>
<span class="token assign-left variable">restore_point</span><span class="token operator">=</span><span class="token string">'2014-10-10T00:00:00.000Z'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr72q:1" aria-labelledby="tab:R4kr72q: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:R4sr72q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr72q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr72q:0" aria-labelledby="tab:R4sr72q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"active"</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">"metadata"</span>: <button class="collapser" aria-label="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">"backup_user_list"</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/Backup-Settings/operation/toggle_user_backup_state" data-section-id="tag/Backup-Settings/operation/toggle_user_backup_state" class="sc-dntaoT ceciOs"><div data-section-id="operation/toggle_user_backup_state" id="operation/toggle_user_backup_state" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Settings/operation/toggle_user_backup_state" aria-label="tag/Backup-Settings/operation/toggle_user_backup_state"></a>Enable or disable legacy backups<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables or disables legacy backups for a user.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables or disables legacy backups for a 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="legacy" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">legacy</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">legacy=0</span></div><div><div html="<p>Whether the account should use the legacy backup system.</p>
<ul>
<li><code>1</code> - Use the legacy backup system.</li>
<li><code>0</code> - Use the standard backup system.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the account should use the legacy backup system.</p>
<ul>
<li><code>1</code> - Use the legacy backup system.</li>
<li><code>0</code> - Use the standard backup system.</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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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 cPanel account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/toggle_user_backup_state</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/toggle_user_backup_state</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kt72q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kt72q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kt72q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt72q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kt72q:0" aria-labelledby="tab:R4kt72q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
toggle_user_backup_state <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R4kt72q:1" aria-labelledby="tab:R4kt72q: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:R4st72q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4st72q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4st72q:0" aria-labelledby="tab:R4st72q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"toggle_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">"metadata"</span>: <button class="collapser" aria-label="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">"toggle_user_backup_state"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Backup state modified"</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/Backup-Settings/operation/backup_config_get" data-section-id="tag/Backup-Settings/operation/backup_config_get" class="sc-dntaoT ceciOs"><div data-section-id="operation/backup_config_get" id="operation/backup_config_get" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup-Settings/operation/backup_config_get" aria-label="tag/Backup-Settings/operation/backup_config_get"></a>Return backup configuration file data<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves your backup destination configuration file data.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves your backup destination configuration file 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/backup_config_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/backup_config_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:R4kv72q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kv72q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kv72q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kv72q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kv72q:0" aria-labelledby="tab:R4kv72q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
backup_config_get
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kv72q:1" aria-labelledby="tab:R4kv72q: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:R4sv72q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sv72q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sv72q:0" aria-labelledby="tab:R4sv72q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_config"</span>: <button class="collapser" aria-label="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_daily_enable"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backup_daily_retention"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backup_monthly_dates"</span>: <span class="token string">"1,15,22"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backup_monthly_enable"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backup_monthly_retention"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backup_weekly_day"</span>: <span class="token string">"1,3,5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backup_weekly_enable"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backup_weekly_retention"</span>: <span class="token number">4</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backupaccts"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backupbwdata"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backupdays"</span>: <span class="token string">"0,2,4,6"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backupdir"</span>: <span class="token string">"/backup"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backupenable"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backupfiles"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backuplogs"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backupmount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backupsuspendedaccounts"</span>: <span class="token number">0</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">"check_min_free_space"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disable_metadata"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorthreshhold"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"force_prune_daily"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"force_prune_monthly"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"force_prune_weekly"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"gziprsyncopts"</span>: <span class="token string">"--rysncable"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"keeplocal"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"linkdest"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"localzonesonly"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_restore_timeout"</span>: <span class="token number">21600</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_timeout"</span>: <span class="token number">7200</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"min_free_space"</span>: <span class="token number">1024</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"min_free_space_unit"</span>: <span class="token string">"MB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysqlbackup"</span>: <span class="token string">"accounts"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"postbackup"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prebackup"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"psqlbackup"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remote_restore_staging_dir"</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">"metadata"</span>: <button class="collapser" aria-label="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">"backup_config_get"</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/Legacy-Migration" data-section-id="tag/Legacy-Migration" 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/Legacy-Migration" aria-label="tag/Legacy-Migration"></a>Legacy Migration</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Backups / Legacy Migration</p>
"><p>Backups / Legacy Migration</p>
</div></div></div><div id="tag/Legacy-Migration/operation/convert_and_migrate_from_legacy_config" data-section-id="tag/Legacy-Migration/operation/convert_and_migrate_from_legacy_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/convert_and_migrate_from_legacy_config" id="operation/convert_and_migrate_from_legacy_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Legacy-Migration/operation/convert_and_migrate_from_legacy_config" aria-label="tag/Legacy-Migration/operation/convert_and_migrate_from_legacy_config"></a>Migrate server to new backup system<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function converts and migrates a server from the Legacy Backup system to the Backup system.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function converts and migrates a server from the Legacy Backup system to the Backup system.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="no_convert" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">no_convert</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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_convert=1</span></div><div><div html="<p>Whether to convert the server from the Legacy Backup system to
the Backup system.</p>
<ul>
<li><code>1</code> — Convert.</li>
<li><code>0</code> — Do <strong>not</strong> convert.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to convert the server from the Legacy Backup system to
the Backup system.</p>
<ul>
<li><code>1</code> — Convert.</li>
<li><code>0</code> — Do <strong>not</strong> convert.</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="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">/convert_and_migrate_from_legacy_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/convert_and_migrate_from_legacy_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:R15792q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R15792q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R15792q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R15792q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R15792q:0" aria-labelledby="tab:R15792q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
convert_and_migrate_from_legacy_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R15792q:1" aria-labelledby="tab:R15792q: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:R17792q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R17792q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R17792q:0" aria-labelledby="tab:R17792q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"convert_and_migrate_from_legacy_config"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Legacy Backup configuration was renamed from /etc/cpbackup.conf to /etc/cpbackup.conf-1485958451 as a backup copy for your records."</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/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/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 and return access token<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function validates a login token with the cPanel Store or a cPanel Market provider, and then returns access tokens.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function validates a login token with the cPanel Store or a cPanel Market provider, and then returns access 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><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=1a676e6f-99fc-11e6-9ab6-e60a769b73bc</span></div><div><div html="<p>The login token to validate.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The login token to validate.</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 Store or cPanel Market provider&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Store or 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>The location to which the cPanel Store or cPanel Market provider redirects the user&#39;s browser after they log in.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The location to which the cPanel Store or 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99r3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99r3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99r3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99r3a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99r3a:0" aria-labelledby="tab:R99r3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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">url_after_login</span><span class="token operator">=</span><span class="token string">'http://hostname.example.com/redirectionlocation.cgi?state'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">login_token</span><span class="token operator">=</span><span class="token string">'1a676e6f-99fc-11e6-9ab6-e60a769b73bc'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99r3a:1" aria-labelledby="tab:R99r3a: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:R9pr3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pr3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pr3a:0" aria-labelledby="tab:R9pr3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"b7a6f029-99fc-11e6-a0bd-87581cb027ac"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"refresh_token"</span>: <span class="token string">"b7a7107f-99fc-11e6-a0bd-b46329164206"</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">"metadata"</span>: <button class="collapser" aria-label="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">"validate_login_token"</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/Configuration" data-section-id="tag/Configuration" 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/Configuration" aria-label="tag/Configuration"></a>Configuration</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Configuration Management / Leika</p>
"><p>Configuration Management / Leika</p>
</div></div></div><div id="tag/Configuration/operation/leika_get_config" data-section-id="tag/Configuration/operation/leika_get_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/leika_get_config" id="operation/leika_get_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Configuration/operation/leika_get_config" aria-label="tag/Configuration/operation/leika_get_config"></a>Retrieve Leika configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves configuration data using <code>Cpanel::Leika::get_config()</code>.
If no <code>item</code> parameters are provided, the entire configuration is returned.
If 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.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves configuration data using <code>Cpanel::Leika::get_config()</code>.
If no <code>item</code> parameters are provided, the entire configuration is returned.
If 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.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><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> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">item=cpanel.key1</span> -<!-- --> <!-- -->Retrieve the value for the `key1` configuration key within the `cpanel` section of the configuration.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">item=webmail.key3.subkey1</span> -<!-- --> <!-- -->Retrieve the value for the nested key `key3.subkey1` within the `webmail` section of the configuration.</li></ul><div><div html="<p>The configuration item(s) to retrieve. Pass multiple <code>item</code> parameters for multiple keys.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The configuration item(s) to retrieve. Pass multiple <code>item</code> parameters for multiple keys.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><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>A hash of configuration keys and their values.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A hash of configuration keys and their values.</p>
</div></div></div></td></tr><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">/leika_get_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/leika_get_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:R99r3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99r3q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99r3q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99r3q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99r3q:0" aria-labelledby="tab:R99r3q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
leika_get_config <span class="token assign-left variable">item</span><span class="token operator">=</span>key1 <span class="token assign-left variable">item</span><span class="token operator">=</span>key2
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99r3q:1" aria-labelledby="tab:R99r3q: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:R9pr3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pr3q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pr3q:0" aria-labelledby="tab:R9pr3q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cpanel.key1"</span>: <span class="token string">"enabled"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webmail.key3"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"subkey1"</span>: <span class="token string">"active"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subkey2"</span>: <span class="token string">"inactive"</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"leika_get_config"</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/Product-Management" data-section-id="tag/Product-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/Product-Management" aria-label="tag/Product-Management"></a>Product Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>cPanel Market / Product Management</p>
"><p>cPanel Market / Product Management</p>
</div></div></div><div id="tag/Product-Management/operation/get_adjusted_market_providers_products" data-section-id="tag/Product-Management/operation/get_adjusted_market_providers_products" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_adjusted_market_providers_products" id="operation/get_adjusted_market_providers_products" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Product-Management/operation/get_adjusted_market_providers_products" aria-label="tag/Product-Management/operation/get_adjusted_market_providers_products"></a>Return Market providers' products adjusted prices<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists all available cPanel Market products from enabled providers,
with the prices that the adjustments database modifies.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all available cPanel Market products from enabled providers,
with the prices that the adjustments database modifies.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_adjusted_market_providers_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_adjusted_market_providers_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:R2a9j4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9j4a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j4a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j4a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9j4a:0" aria-labelledby="tab:R2a9j4a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_adjusted_market_providers_products
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j4a:1" aria-labelledby="tab:R2a9j4a: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:R2e9j4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9j4a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9j4a:0" aria-labelledby="tab:R2e9j4a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"products"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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></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">"command"</span>: <span class="token string">"get_adjusted_market_providers_products"</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/Product-Management/operation/get_market_providers_product_metadata" data-section-id="tag/Product-Management/operation/get_market_providers_product_metadata" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_market_providers_product_metadata" id="operation/get_market_providers_product_metadata" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Product-Management/operation/get_market_providers_product_metadata" aria-label="tag/Product-Management/operation/get_market_providers_product_metadata"></a>Return Market providers' products metadata<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists all available cPanel Market providers&#39; products and the attributes of
each product that can be managed by an administrator.</p>
<p>The return list includes different <code>attribute</code> data depending the <code>product_group</code> for each product.</p>
<table>
<tr>
<th>Product Group</th>
<th>Attributes Returned</th>
<th>Description</th>
</tr>
<tr>
<td>ssl_certificate</td>
<td>SSLMarketProviderMetaData</td>
<td>Contains additional attributes only applicable to SSL Certificates</td>
</tr>
<tr>
<td>*</td>
<td>MarketProviderMetaData</td>
<td>Any products not in a <code>product_group</code> listed above will include only these attributes.</td>
</tr>
</table>
<p><strong>Note:</strong></p>
<p>The function does <strong>not</strong> return the <code>product_group</code> name.</p>
<p>To get the <code>product_group</code> name for a <code>product_id</code>, run WHM API 1&#39;s <a href="https://go.cpanel.net/Market-get-market-providers-products"><code>get_market_providers_products</code></a> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all available cPanel Market providers' products and the attributes of
each product that can be managed by an administrator.</p>
<p>The return list includes different <code>attribute</code> data depending the <code>product_group</code> for each product.</p>
<table>
<tr>
<th>Product Group</th>
<th>Attributes Returned</th>
<th>Description</th>
</tr>
<tr>
<td>ssl_certificate</td>
<td>SSLMarketProviderMetaData</td>
<td>Contains additional attributes only applicable to SSL Certificates</td>
</tr>
<tr>
<td>*</td>
<td>MarketProviderMetaData</td>
<td>Any products not in a <code>product_group</code> listed above will include only these attributes.</td>
</tr>
</table>
<p><strong>Note:</strong></p>
<p>The function does <strong>not</strong> return the <code>product_group</code> name.</p>
<p>To get the <code>product_group</code> name for a <code>product_id</code>, run WHM API 1's <a href="https://go.cpanel.net/Market-get-market-providers-products"><code>get_market_providers_products</code></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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_market_providers_product_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_market_providers_product_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:R2aaj4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aaj4a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj4a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj4a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aaj4a:0" aria-labelledby="tab:R2aaj4a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_market_providers_product_metadata
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj4a:1" aria-labelledby="tab:R2aaj4a: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:R2eaj4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eaj4a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eaj4a:0" aria-labelledby="tab:R2eaj4a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"product_metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="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>: <span class="token number">1</span></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>: <button class="collapser" aria-label="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>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</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">"read_only"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_mime_type"</span>: <button class="collapser" aria-label="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>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"minimum_server_price"</span>: <button class="collapser" aria-label="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>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"price"</span>: <button class="collapser" aria-label="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>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"price_unit"</span>: <button class="collapser" aria-label="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>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_description"</span>: <button class="collapser" aria-label="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>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_group"</span>: <button class="collapser" aria-label="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>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_id"</span>: <button class="collapser" aria-label="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>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recommended"</span>: <button class="collapser" aria-label="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>: <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">"product_id"</span>: <span class="token string">"123"</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></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">"metadata"</span>: <button class="collapser" aria-label="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">"get_market_providers_product_metadata"</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/Product-Management/operation/Market-get_market_providers_products" data-section-id="tag/Product-Management/operation/Market-get_market_providers_products" class="sc-dntaoT ceciOs"><div data-section-id="operation/Market-get_market_providers_products" id="operation/Market-get_market_providers_products" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Product-Management/operation/Market-get_market_providers_products" aria-label="tag/Product-Management/operation/Market-get_market_providers_products"></a>Return Market providers products<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists products available in the server&#39;s cPanel Market.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists products available in the server's cPanel Market.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_market_providers_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_market_providers_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:R2abj4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abj4a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abj4a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj4a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abj4a:0" aria-labelledby="tab:R2abj4a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_market_providers_products
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj4a:1" aria-labelledby="tab:R2abj4a: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:R2ebj4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebj4a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebj4a:0" aria-labelledby="tab:R2ebj4a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"products"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"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 string">"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 string">"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">"requires_ip"</span>: <span class="token string">"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 string">"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">"A 2-year 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">"2-Year Comodo EV SSL Certificate"</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 string">"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 string">"261"</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">"requires_ip"</span>: <span class="token string">"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 string">"2"</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">216</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">2160</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">216</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">"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 string">"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 string">"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">"requires_ip"</span>: <span class="token string">"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 string">"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 2-year 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">"2-Year Comodo OV SSL Certificate"</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 string">"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 string">"253"</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">"requires_ip"</span>: <span class="token string">"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 string">"2"</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">72</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">720</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">72</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">"300.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">"3000.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">"300.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">"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 string">"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 string">"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">"requires_ip"</span>: <span class="token string">"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 string">"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">"A 2-year 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">"2-Year cPanel DV SSL Certificate"</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 string">"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 string">"225"</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">"requires_ip"</span>: <span class="token string">"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 string">"2"</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">18</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">60</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">6</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">"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">"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 string">"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 string">"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">"requires_ip"</span>: <span class="token string">"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 string">"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 2-year 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">"2-Year cPanel OV SSL Certificate"</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 string">"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 string">"233"</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">"requires_ip"</span>: <span class="token string">"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 string">"2"</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">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_price_per_wildcard_domain"</span>: <span class="token string">"198.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">"1980.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">"198.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">"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 string">"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 string">"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">"requires_ip"</span>: <span class="token string">"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 string">"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">"A 2-year 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">"2-Year Comodo DV SSL Certificate"</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 string">"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 string">"245"</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">"requires_ip"</span>: <span class="token string">"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 string">"2"</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">24</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">240</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">24</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">"198.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">"1980.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">"198.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">"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 string">"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 string">"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">"requires_ip"</span>: <span class="token string">"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 string">"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><li><div class="hoverable "><button class="collapser" aria-label="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 2-year 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">"2-Year cPanel EV SSL Certificate"</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 string">"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 string">"241"</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">"requires_ip"</span>: <span class="token string">"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 string">"2"</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">120</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">1200</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">120</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></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">"command"</span>: <span class="token string">"get_market_providers_products"</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/Product-Management/operation/set_market_product_attribute" data-section-id="tag/Product-Management/operation/set_market_product_attribute" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_market_product_attribute" id="operation/set_market_product_attribute" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Product-Management/operation/set_market_product_attribute" aria-label="tag/Product-Management/operation/set_market_product_attribute"></a>Update Market provider product<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets an attribute for a cPanel Market provider&#39;s product.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets an attribute for a cPanel Market provider's product.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="attribute" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">attribute</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">attribute=price</span></div><div><div html="<p>The attribute of the cPanel Market provider&#39;s product.</p>
<p><strong>Note</strong></p>
<p>Attributes vary between cPanel Market providers and products.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The attribute of the cPanel Market provider's product.</p>
<p><strong>Note</strong></p>
<p>Attributes vary between cPanel Market providers and products.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="product_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">product_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">product_id=12345</span></div><div><div html="<p>The cPanel Market provider product&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider product's name.</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="value" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">value</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">value=6.00</span></div><div><div html="<p>The value to set for the attribute.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The value to set for the attribute.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/set_market_product_attribute</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_market_product_attribute</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acj4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acj4a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acj4a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj4a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acj4a:0" aria-labelledby="tab:R2acj4a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_market_product_attribute <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">product_id</span><span class="token operator">=</span><span class="token string">'12345'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">attribute</span><span class="token operator">=</span><span class="token string">'price'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">value</span><span class="token operator">=</span><span class="token string">'6.00'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj4a:1" aria-labelledby="tab:R2acj4a: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:R2ecj4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecj4a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecj4a:0" aria-labelledby="tab:R2ecj4a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_market_product_attribute"</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/Provider-Management" data-section-id="tag/Provider-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/Provider-Management" aria-label="tag/Provider-Management"></a>Provider Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>cPanel Market / Provider Management</p>
"><p>cPanel Market / Provider Management</p>
</div></div></div><div id="tag/Provider-Management/operation/disable_market_provider" data-section-id="tag/Provider-Management/operation/disable_market_provider" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_market_provider" id="operation/disable_market_provider" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Provider-Management/operation/disable_market_provider" aria-label="tag/Provider-Management/operation/disable_market_provider"></a>Disable Market provider<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function disables a cPanel Market provider.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables a 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="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=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="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">/disable_market_provider</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/disable_market_provider</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9l4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9l4a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l4a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l4a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9l4a:0" aria-labelledby="tab:R2a9l4a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
disable_market_provider <span class="token punctuation">\</span>
<span class="token assign-left variable">name</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:R2a9l4a:1" aria-labelledby="tab:R2a9l4a: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:R2e9l4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9l4a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9l4a:0" aria-labelledby="tab:R2e9l4a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"disable_market_provider"</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/Provider-Management/operation/enable_market_provider" data-section-id="tag/Provider-Management/operation/enable_market_provider" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_market_provider" id="operation/enable_market_provider" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Provider-Management/operation/enable_market_provider" aria-label="tag/Provider-Management/operation/enable_market_provider"></a>Enable Market provider<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables a cPanel Market provider.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables a 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="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=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="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">/enable_market_provider</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/enable_market_provider</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aal4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aal4a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aal4a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal4a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aal4a:0" aria-labelledby="tab:R2aal4a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
enable_market_provider <span class="token punctuation">\</span>
<span class="token assign-left variable">name</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:R2aal4a:1" aria-labelledby="tab:R2aal4a: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:R2eal4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eal4a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eal4a:0" aria-labelledby="tab:R2eal4a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"enable_market_provider"</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/Provider-Management/operation/get_market_providers_commission_config" data-section-id="tag/Provider-Management/operation/get_market_providers_commission_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_market_providers_commission_config" id="operation/get_market_providers_commission_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Provider-Management/operation/get_market_providers_commission_config" aria-label="tag/Provider-Management/operation/get_market_providers_commission_config"></a>Return Market providers' commission configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the commission configuration of all available cPanel Market providers.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the commission configuration of all available 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_market_providers_commission_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_market_providers_commission_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:R2abl4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abl4a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abl4a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl4a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abl4a:0" aria-labelledby="tab:R2abl4a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_market_providers_commission_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl4a:1" aria-labelledby="tab:R2abl4a: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:R2ebl4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebl4a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebl4a:0" aria-labelledby="tab:R2ebl4a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"local_commission_id"</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">"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">"remote_commission_id"</span>: <span class="token string">"user@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">"metadata"</span>: <button class="collapser" aria-label="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">"get_market_providers_commission_config"</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/Provider-Management/operation/get_market_providers_list" data-section-id="tag/Provider-Management/operation/get_market_providers_list" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_market_providers_list" id="operation/get_market_providers_list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Provider-Management/operation/get_market_providers_list" aria-label="tag/Provider-Management/operation/get_market_providers_list"></a>Return Market providers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the available cPanel Market providers.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the available 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_market_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_market_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:R2acl4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acl4a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acl4a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl4a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acl4a:0" aria-labelledby="tab:R2acl4a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_market_providers_list
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl4a:1" aria-labelledby="tab:R2acl4a: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:R2ecl4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecl4a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecl4a:0" aria-labelledby="tab:R2ecl4a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"even_commission_divisor"</span>: <span class="token number">6</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"supports_commission"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_market_providers_list"</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/Provider-Management/operation/set_market_provider_commission_id" data-section-id="tag/Provider-Management/operation/set_market_provider_commission_id" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_market_provider_commission_id" id="operation/set_market_provider_commission_id" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Provider-Management/operation/set_market_provider_commission_id" aria-label="tag/Provider-Management/operation/set_market_provider_commission_id"></a>Update Market provider commission contact ID<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the contact ID to which a cPanel Market provider will send commission.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the contact ID to which a cPanel Market provider will send commission.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="commission_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">commission_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">commission_id=user@example.com</span></div><div><div html="<p>The cPanel Store ID to which to send cPanel Market commissions.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Store ID to which to send cPanel Market commissions.</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="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">/set_market_provider_commission_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_market_provider_commission_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:R2adl4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adl4a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adl4a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adl4a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adl4a:0" aria-labelledby="tab:R2adl4a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_market_provider_commission_id <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">commission_id</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:R2adl4a:1" aria-labelledby="tab:R2adl4a: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:R2edl4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edl4a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edl4a:0" aria-labelledby="tab:R2edl4a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_market_provider_commission_id"</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/Support-Access" data-section-id="tag/Support-Access" 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/Support-Access" aria-label="tag/Support-Access"></a>Support Access</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>cPanel Support Tickets / Support Access</p>
"><p>cPanel Support Tickets / Support Access</p>
</div></div></div><div id="tag/Support-Access/operation/ticket_grant" data-section-id="tag/Support-Access/operation/ticket_grant" class="sc-dntaoT ceciOs"><div data-section-id="operation/ticket_grant" id="operation/ticket_grant" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Support-Access/operation/ticket_grant" aria-label="tag/Support-Access/operation/ticket_grant"></a>Create Support SSH key<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function installs an SSH key from the
<a href="https://tickets.cpanel.net/">cPanel Customer Portal</a>.</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call
it as a request body.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function installs an SSH key from the
<a href="https://tickets.cpanel.net/">cPanel Customer Portal</a>.</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call
it as a request body.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="secure_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">secure_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">secure_id=rofh411bv8</span></div><div><div html="<p>The support ticket&#39;s secure ID token.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The support ticket's secure ID token.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="server_num" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">server_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><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">server_num=1</span></div><div><div html="<p>The server&#39;s support ticket ID number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server's support ticket ID number.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="ssh_username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ssh_username</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ssh_username=username</span></div><div><div html="<p>The username for incoming SSH connections before they escalate to the <code>root</code> user. If you do <strong>not</strong> specify a value, the function retrieves the user from the support ticket.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username for incoming SSH connections before they escalate to the <code>root</code> user. If you do <strong>not</strong> specify a value, the function retrieves the user from the support ticket.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="ticket_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ticket_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">ticket_id=999999999</span></div><div><div html="<p>The support ticket&#39;s ID number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The support ticket'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ticket_grant</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ticket_grant</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4khj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4khj4q:0" tabindex="0" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4khj4q:0" aria-labelledby="tab:R4khj4q:0"><div class="sc-bbQqnZ 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:2087/cpsess##########/json-api/ticket_grant?api.version=1&ticket_id=999999999&secure_id=rofh411bv8&server_num=1</span></span></pre></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4shj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4shj4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4shj4q:0" aria-labelledby="tab:R4shj4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_status"</span>: <span class="token string">"AUTHED"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_time"</span>: <span class="token number">1477338450</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"chain_status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"csf_wl_status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host_access_wl_status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hulk_wl_status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"non_fatals"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server_name"</span>: <span class="token string">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server_num"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssh_username"</span>: <span class="token string">"username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ticket_id"</span>: <span class="token number">999999999</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ticket_status"</span>: <span class="token string">"OPEN"</span></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">"command"</span>: <span class="token string">"ticket_grant"</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/Support-Access/operation/ticket_revoke" data-section-id="tag/Support-Access/operation/ticket_revoke" class="sc-dntaoT ceciOs"><div data-section-id="operation/ticket_revoke" id="operation/ticket_revoke" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Support-Access/operation/ticket_revoke" aria-label="tag/Support-Access/operation/ticket_revoke"></a>Delete Support SSH key<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes a
<a href="https://tickets.cpanel.net/">cPanel Customer Portal</a>
SSH key from the server.</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it
as a request body.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a
<a href="https://tickets.cpanel.net/">cPanel Customer Portal</a>
SSH key from the server.</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it
as a request body.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="server_num" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">server_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><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">server_num=1</span></div><div><div html="<p>The server&#39;s ID number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server's ID number.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="ssh_username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ssh_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">ssh_username=username</span></div><div><div html="<p>The username for incoming SSH connections before they escalate to the <code>root</code> user.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username for incoming SSH connections before they escalate to the <code>root</code> user.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="ticket_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ticket_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">ticket_id=999999999</span></div><div><div html="<p>The support ticket&#39;s ID number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The support ticket'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ticket_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ticket_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:R4kij4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kij4q:0" tabindex="0" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kij4q:0" aria-labelledby="tab:R4kij4q:0"><div class="sc-bbQqnZ 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:2087/cpsess##########/json-api/ticket_revoke?api.version=1&ticket_id=999999999&server_num=1&ssh_username=username</span></span></pre></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sij4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sij4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sij4q:0" aria-labelledby="tab:R4sij4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"chain_status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"csf_wl_status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host_access_wl_status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hulk_wl_status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"non_fatals"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"revoked_keys"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server_num"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssh_username"</span>: <span class="token string">"username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ticket_id"</span>: <span class="token number">999999999</span></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">"command"</span>: <span class="token string">"ticket_revoke"</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/Support-Access/operation/ticket_remove_closed" data-section-id="tag/Support-Access/operation/ticket_remove_closed" class="sc-dntaoT ceciOs"><div data-section-id="operation/ticket_remove_closed" id="operation/ticket_remove_closed" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Support-Access/operation/ticket_remove_closed" aria-label="tag/Support-Access/operation/ticket_remove_closed"></a>Delete Support SSH key and closed tickets<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes cPanel Support&#39;s SSH keys and removes closed
support tickets. You can view closed support tickets in WHM&#39;s
<a href="https://docs.cpanel.net/whm/support/grant-cpanel-support-access/"><em>Grant cPanel Support Access</em></a>
interface (<em>WHM &gt;&gt; Home &gt;&gt; Support &gt;&gt; Grant cPanel Support Access</em>).</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call
it as a request body.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes cPanel Support's SSH keys and removes closed
support tickets. You can view closed support tickets in WHM's
<a href="https://docs.cpanel.net/whm/support/grant-cpanel-support-access/"><em>Grant cPanel Support Access</em></a>
interface (<em>WHM >> Home >> Support >> Grant cPanel Support Access</em>).</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call
it as a request body.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ticket_remove_closed</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ticket_remove_closed</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kjj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kjj4q:0" tabindex="0" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kjj4q:0" aria-labelledby="tab:R4kjj4q:0"><div class="sc-bbQqnZ 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:2087/cpsess##########/json-api/ticket_remove_closed?api.version=1</span></span></pre></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sjj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sjj4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sjj4q:0" aria-labelledby="tab:R4sjj4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"chain_status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"csf_wl_status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host_access_wl_status"</span>: <span class="token string">"INACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hulk_wl_status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"non_fatals"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"revoked_keys"</span>: <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">"metadata"</span>: <button class="collapser" aria-label="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">"ticket_remove_closed"</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/Support-Access/operation/ticket_ssh_test" data-section-id="tag/Support-Access/operation/ticket_ssh_test" class="sc-dntaoT ceciOs"><div data-section-id="operation/ticket_ssh_test" id="operation/ticket_ssh_test" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Support-Access/operation/ticket_ssh_test" aria-label="tag/Support-Access/operation/ticket_ssh_test"></a>Validate Customer Portal connection<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function verifies the connection from the
<a href="https://tickets.cpanel.net/">cPanel Customer Portal</a>
to the server.</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it as
a request body.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function verifies the connection from the
<a href="https://tickets.cpanel.net/">cPanel Customer Portal</a>
to the server.</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it as
a request body.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="server_num" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">server_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><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">server_num=2</span></div><div><div html="<p>The server&#39;s ID number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server's ID number.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="ticket_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ticket_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">ticket_id=999999999</span></div><div><div html="<p>The ticket&#39;s ID number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ticket'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ticket_ssh_test</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ticket_ssh_test</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kkj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kkj4q:0" tabindex="0" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kkj4q:0" aria-labelledby="tab:R4kkj4q:0"><div class="sc-bbQqnZ 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:2087/cpsess##########/json-api/ticket_ssh_test?api.version=1&ticket_id=999999999&server_num=2</span></span></pre></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4skj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4skj4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4skj4q:0" aria-labelledby="tab:R4skj4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"non_fatals"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"audit_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">"result"</span>: <span class="token string">"SUCCESS"</span></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">"command"</span>: <span class="token string">"ticket_ssh_test"</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/Support-Access/operation/ticket_ssh_test_start" data-section-id="tag/Support-Access/operation/ticket_ssh_test_start" class="sc-dntaoT ceciOs"><div data-section-id="operation/ticket_ssh_test_start" id="operation/ticket_ssh_test_start" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Support-Access/operation/ticket_ssh_test_start" aria-label="tag/Support-Access/operation/ticket_ssh_test_start"></a>Validate Support SSH connection<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function initiates an SSH connection test.</p>
<p><strong>Important:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it
as a request body.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function initiates an SSH connection test.</p>
<p><strong>Important:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it
as a request body.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="server_num" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">server_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><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">server_num=1</span></div><div><div html="<p>An integer that represents the ticket&#39;s actionable server. Increment the value by one for each server in the support ticket.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An integer that represents the ticket's actionable server. Increment the value by one for each server in the support ticket.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="ticket_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ticket_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">ticket_id=7648492</span></div><div><div html="<p>The support ticket number that other functions can use to query or make additional changes to the support ticket.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The support ticket number that other functions can use to query or make additional changes to the support ticket.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ticket_ssh_test_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ticket_ssh_test_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:R4klj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4klj4q:0" tabindex="0" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4klj4q:0" aria-labelledby="tab:R4klj4q:0"><div class="sc-bbQqnZ 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:2087/cpsess##########/json-api/ticket_ssh_test_start?api.version=1&ticket_id=7648492&server_num=1</span></span></pre></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4slj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4slj4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4slj4q:0" aria-labelledby="tab:R4slj4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"ticket_ssh_test_start"</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/Support-Access/operation/ticket_whitelist_check" data-section-id="tag/Support-Access/operation/ticket_whitelist_check" class="sc-dntaoT ceciOs"><div data-section-id="operation/ticket_whitelist_check" id="operation/ticket_whitelist_check" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Support-Access/operation/ticket_whitelist_check" aria-label="tag/Support-Access/operation/ticket_whitelist_check"></a>Validate Support IP addresses on firewall<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks whether the server&#39;s firewall whitelist correlates
with the granted support tickets. You can view granted support tickets in
WHM&#39;s
<a href="https://docs.cpanel.net/whm/support/grant-cpanel-support-access/"><em>Grant cPanel Support Access</em></a>
interface (<em>WHM &gt;&gt; Home &gt;&gt; Support &gt;&gt; Grant cPanel Support Access</em>).</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it as
a request body.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the server's firewall whitelist correlates
with the granted support tickets. You can view granted support tickets in
WHM's
<a href="https://docs.cpanel.net/whm/support/grant-cpanel-support-access/"><em>Grant cPanel Support Access</em></a>
interface (<em>WHM >> Home >> Support >> Grant cPanel Support Access</em>).</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it as
a request body.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ticket_whitelist_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ticket_whitelist_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:R4kmj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kmj4q:0" tabindex="0" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kmj4q:0" aria-labelledby="tab:R4kmj4q:0"><div class="sc-bbQqnZ 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:2087/cpsess##########/json-api/ticket_whitelist_check?api.version=1</span></span></pre></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4smj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4smj4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4smj4q:0" aria-labelledby="tab:R4smj4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"chain_status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"problem"</span>: <span class="token string">"NO"</span></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">"command"</span>: <span class="token string">"ticket_whitelist_check"</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/Support-Access/operation/ticket_whitelist_setup" data-section-id="tag/Support-Access/operation/ticket_whitelist_setup" class="sc-dntaoT ceciOs"><div data-section-id="operation/ticket_whitelist_setup" id="operation/ticket_whitelist_setup" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Support-Access/operation/ticket_whitelist_setup" aria-label="tag/Support-Access/operation/ticket_whitelist_setup"></a>Add Support IP addresses to firewall<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds cPanel Support&#39;s IP addresses to your server&#39;s firewall
whitelist. This function is firewall-specific and does <strong>not</strong> change the
<a href="https://docs.cpanel.net/whm/security-center/cphulk-brute-force-protection/">cPHulk</a>
whitelist.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it as
a request body.</li>
<li>This function logs error messages to the
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/the-cpanel-log-files/#usr-local-cpanel-logs-error-log"><code>/usr/local/cpanel/logs/error_log</code></a>
file.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds cPanel Support's IP addresses to your server's firewall
whitelist. This function is firewall-specific and does <strong>not</strong> change the
<a href="https://docs.cpanel.net/whm/security-center/cphulk-brute-force-protection/">cPHulk</a>
whitelist.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it as
a request body.</li>
<li>This function logs error messages to the
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/the-cpanel-log-files/#usr-local-cpanel-logs-error-log"><code>/usr/local/cpanel/logs/error_log</code></a>
file.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ticket_whitelist_setup</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ticket_whitelist_setup</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4knj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4knj4q:0" tabindex="0" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4knj4q:0" aria-labelledby="tab:R4knj4q:0"><div class="sc-bbQqnZ 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:2087/cpsess##########/json-api/ticket_whitelist_setup?api.version=1</span></span></pre></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4snj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4snj4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4snj4q:0" aria-labelledby="tab:R4snj4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"chain_status"</span>: <span class="token string">"ACTIVE"</span></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">"command"</span>: <span class="token string">"ticket_whitelist_setup"</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/Support-Access/operation/ticket_whitelist_unsetup" data-section-id="tag/Support-Access/operation/ticket_whitelist_unsetup" class="sc-dntaoT ceciOs"><div data-section-id="operation/ticket_whitelist_unsetup" id="operation/ticket_whitelist_unsetup" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Support-Access/operation/ticket_whitelist_unsetup" aria-label="tag/Support-Access/operation/ticket_whitelist_unsetup"></a>Remove Support IP addresses from firewall<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes cPanel Support&#39;s IP addresses from your server&#39;s firewall
whitelist. This function is firewall-specific and does <strong>not</strong> change the
<a href="https://docs.cpanel.net/whm/security-center/cphulk-brute-force-protection/">cPHulk</a>
whitelist.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it as
a request body.</li>
<li>This function logs error messages to the
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/the-cpanel-log-files/#usr-local-cpanel-logs-error-log"><code>/usr/local/cpanel/logs/error_log</code></a>
file.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes cPanel Support's IP addresses from your server's firewall
whitelist. This function is firewall-specific and does <strong>not</strong> change the
<a href="https://docs.cpanel.net/whm/security-center/cphulk-brute-force-protection/">cPHulk</a>
whitelist.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it as
a request body.</li>
<li>This function logs error messages to the
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/the-cpanel-log-files/#usr-local-cpanel-logs-error-log"><code>/usr/local/cpanel/logs/error_log</code></a>
file.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ticket_whitelist_unsetup</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ticket_whitelist_unsetup</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4koj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4koj4q:0" tabindex="0" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4koj4q:0" aria-labelledby="tab:R4koj4q:0"><div class="sc-bbQqnZ 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:2087/cpsess##########/json-api/ticket_whitelist_unsetup?api.version=1</span></span></pre></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4soj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4soj4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4soj4q:0" aria-labelledby="tab:R4soj4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"chain_status"</span>: <span class="token string">"INACTIVE"</span></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">"command"</span>: <span class="token string">"ticket_whitelist_unsetup"</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/Ticket-Management" data-section-id="tag/Ticket-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/Ticket-Management" aria-label="tag/Ticket-Management"></a>Ticket Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>cPanel Support Tickets / Ticket Management</p>
"><p>cPanel Support Tickets / Ticket Management</p>
</div></div></div><div id="tag/Ticket-Management/operation/ticket_create_stub_ticket" data-section-id="tag/Ticket-Management/operation/ticket_create_stub_ticket" class="sc-dntaoT ceciOs"><div data-section-id="operation/ticket_create_stub_ticket" id="operation/ticket_create_stub_ticket" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Ticket-Management/operation/ticket_create_stub_ticket" aria-label="tag/Ticket-Management/operation/ticket_create_stub_ticket"></a>Create initial Support ticket request<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates a stub ticket. The system uses the stub ticket
to create a cPanel support ticket.</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call
it as a request body.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a stub ticket. The system uses the stub ticket
to create a cPanel support ticket.</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call
it as a request body.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ticket_create_stub_ticket</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ticket_create_stub_ticket</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" 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">URL</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"><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:2087/cpsess##########/json-api/ticket_create_stub_ticket?api.version=1</span></span></pre></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ 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">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"secure_id"</span>: <span class="token string">"rofh411bv8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ticket_id"</span>: <span class="token number">7648492</span></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">"command"</span>: <span class="token string">"ticket_create_stub_ticket"</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/Ticket-Management/operation/ticket_get_support_agreement" data-section-id="tag/Ticket-Management/operation/ticket_get_support_agreement" class="sc-dntaoT ceciOs"><div data-section-id="operation/ticket_get_support_agreement" id="operation/ticket_get_support_agreement" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Ticket-Management/operation/ticket_get_support_agreement" aria-label="tag/Ticket-Management/operation/ticket_get_support_agreement"></a>Import Technical Support Agreement text<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the WebPros International, LLC Technical Support Agreement text
and metadata about the user&#39;s agreement status from the
<a href="https://tickets.cpanel.net/">cPanel Customer Portal</a>.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it
as a request body.</li>
<li>To use this function, you <strong>must</strong> set up a cPanelID token in your current session.
For more information, read our
<a href="https://docs.cpanel.net/knowledge-base/accounts/cpanelid/">cPanelID</a>
documentation.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the WebPros International, LLC Technical Support Agreement text
and metadata about the user's agreement status from the
<a href="https://tickets.cpanel.net/">cPanel Customer Portal</a>.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it
as a request body.</li>
<li>To use this function, you <strong>must</strong> set up a cPanelID token in your current session.
For more information, read our
<a href="https://docs.cpanel.net/knowledge-base/accounts/cpanelid/">cPanelID</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ticket_get_support_agreement</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ticket_get_support_agreement</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" 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">URL</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"><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:2087/cpsess##########/json-api/ticket_get_support_agreement?api.version=1</span></span></pre></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ 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">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"accepted"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"accepted_date"</span>: <span class="token number">1566000000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"accepted_date_human"</span>: <span class="token string">"8/17/19"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"body"</span>: <span class="token string">"<p>IMPORTANT: THIS TECHNICAL SUPPORT AGREEMENT ... at the end of AGREEMENT"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_date"</span>: <span class="token number">1564790400</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_date_human"</span>: <span class="token string">"8/3/19"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"download_url"</span>: <span class="token string">"</span><a href="https://www.cpanel.net/legal/techagreement_download.cgi">https://www.cpanel.net/legal/techagreement_download.cgi</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">"Technical Support Agreement"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"2019-04.v01.TSUPPORT"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"view_url"</span>: <span class="token string">"</span><a href="http://cpanel.com/technical-support-agreements.html">http://cpanel.com/technical-support-agreements.html</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">"metadata"</span>: <button class="collapser" aria-label="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">"ticket_get_support_agreement"</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/Ticket-Management/operation/ticket_get_support_info" data-section-id="tag/Ticket-Management/operation/ticket_get_support_info" class="sc-dntaoT ceciOs"><div data-section-id="operation/ticket_get_support_info" id="operation/ticket_get_support_info" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Ticket-Management/operation/ticket_get_support_info" aria-label="tag/Ticket-Management/operation/ticket_get_support_info"></a>Import customer information from Customer Portal<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the license holder&#39;s support-related information.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call
it as a request body.</li>
<li>To use this function, you <strong>must</strong> set up a cPanelID token in your current session.
For more information, read our
<a href="https://docs.cpanel.net/knowledge-base/accounts/cpanelid/">cPanelID</a>
documentation.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the license holder's support-related information.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call
it as a request body.</li>
<li>To use this function, you <strong>must</strong> set up a cPanelID token in your current session.
For more information, read our
<a href="https://docs.cpanel.net/knowledge-base/accounts/cpanelid/">cPanelID</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ticket_get_support_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ticket_get_support_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:R2abl4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abl4q:0" tabindex="0" data-rttab="true">URL</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"><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:2087/cpsess##########/json-api/ticket_get_support_info?api.version=1</span></span></pre></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ 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">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"arch"</span>: <span class="token string">"x86_64"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"arch_supported"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"company_id"</span>: <span class="token number">7</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"company_name"</span>: <span class="token string">"Example, L.L.C."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"distro"</span>: <span class="token string">"centos enterprise 6.8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"distro_supported"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"gets_direct_support"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_company_info"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_compatibility_info"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hostname"</span>: <span class="token string">"server.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">"logo_url"</span>: <span class="token string">"</span><a href="http://example.com/assets/ourlogo.png">http://example.com/assets/ourlogo.png</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pub_support_contact"</span>: <span class="token string">"</span><a href="http://documentation.example.com/">http://documentation.example.com/</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pub_tech_contact"</span>: <span class="token string">"</span><a href="https://support.example.com/">https://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">"tech_contact_email"</span>: <span class="token string">"support@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">"command"</span>: <span class="token string">"ticket_get_support_info"</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/Ticket-Management/operation/ticket_list" data-section-id="tag/Ticket-Management/operation/ticket_list" class="sc-dntaoT ceciOs"><div data-section-id="operation/ticket_list" id="operation/ticket_list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Ticket-Management/operation/ticket_list" aria-label="tag/Ticket-Management/operation/ticket_list"></a>Return Support ticket status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists all active and open support tickets from the
<a href="https://tickets.cpanel.net/">cPanel Customer Portal</a>.</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call
it as a request body.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all active and open support tickets from the
<a href="https://tickets.cpanel.net/">cPanel Customer Portal</a>.</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call
it as a request body.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="server_num" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">server_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><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">server_num=2</span></div><div><div html="<p>The server&#39;s ID number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server's ID number.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="ssh_username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ssh_username</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ssh_username=username</span></div><div><div html="<p>The username for incoming SSH connections before they escalate to the <code>root</code> user. If you do not specify a value, the function will select the user from the ticket.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username for incoming SSH connections before they escalate to the <code>root</code> user. If you do not specify a value, the function will select the user from the ticket.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="ticket_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ticket_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">ticket_id=999999999</span></div><div><div html="<p>The ticket&#39;s ID number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ticket'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ticket_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ticket_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:R2acl4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acl4q:0" tabindex="0" data-rttab="true">URL</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"><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:2087/cpsess##########/json-api/ticket_list?api.version=1&ticket_id=999999999&server_num=2</span></span></pre></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ 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">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"auths"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"servers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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_status"</span>: <span class="token string">"AUTHED"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_time"</span>: <span class="token number">1400603208</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server_name"</span>: <span class="token string">"My Server"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server_num"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssh"</span>: <span class="token string">"10.11.12.13:22"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssh_username"</span>: <span class="token string">"username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"whm_ip"</span>: <span class="token string">"10.11.12.13"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ticket_id"</span>: <span class="token number">999999999</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ticket_status"</span>: <span class="token string">"OPEN"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ticket_subject"</span>: <span class="token string">"Example ticket"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"non_fatals"</span>: <span class="token punctuation">[ ]</span></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">"command"</span>: <span class="token string">"ticket_list"</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/Ticket-Management/operation/ticket_update_service_agreement_approval" data-section-id="tag/Ticket-Management/operation/ticket_update_service_agreement_approval" class="sc-dntaoT ceciOs"><div data-section-id="operation/ticket_update_service_agreement_approval" id="operation/ticket_update_service_agreement_approval" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Ticket-Management/operation/ticket_update_service_agreement_approval" aria-label="tag/Ticket-Management/operation/ticket_update_service_agreement_approval"></a>Enable Technical Support Agreement acceptance<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function records a user&#39;s acceptance of the Technical Support
Agreement (TSA). The cPanel Customer Portal stores each record with the user&#39;s
login, the date and time, and the TSA&#39;s version.</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line.
You <strong>must</strong> call it as a request body.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function records a user's acceptance of the Technical Support
Agreement (TSA). The cPanel Customer Portal stores each record with the user's
login, the date and time, and the TSA's version.</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line.
You <strong>must</strong> call it as a request body.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><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=2020-04.v01.TSUPPORT</span></div><div><div html="<p>The version of the TSA that the user approved.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the TSA that the user approved.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/ticket_update_service_agreement_approval</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ticket_update_service_agreement_approval</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" 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">URL</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"><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:2087/cpsess##########/json-api/ticket_update_service_agreement_approval?api.version=1&version=2020-04.v01.TSUPPORT</span></span></pre></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ 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">"metadata"</span>: <button class="collapser" aria-label="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">"ticket_update_service_agreement_approval"</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/Ticket-Management/operation/ticket_validate_oauth2_code" data-section-id="tag/Ticket-Management/operation/ticket_validate_oauth2_code" class="sc-dntaoT ceciOs"><div data-section-id="operation/ticket_validate_oauth2_code" id="operation/ticket_validate_oauth2_code" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Ticket-Management/operation/ticket_validate_oauth2_code" aria-label="tag/Ticket-Management/operation/ticket_validate_oauth2_code"></a>Validate Customer Portal OAuth2 code<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function validates the OAuth2 code from the
<a href="https://tickets.cpanel.net/">cPanel Customer Portal</a>.
After the function validates the token, the system stores it on the current session.</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it
as a request body.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function validates the OAuth2 code from the
<a href="https://tickets.cpanel.net/">cPanel Customer Portal</a>.
After the function validates the token, the system stores it on the current session.</p>
<p><strong>Note:</strong></p>
<p>This function is <strong>not</strong> available through the command line. You <strong>must</strong> call it
as a request body.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="code" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">code</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">code=84b1a729-63e3-11e6-a0fb-bfcf357fd76d</span></div><div><div html="<p>The code from the OAuth2 redirect. The system validates this code and exchanges it for a token.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The code from the OAuth2 redirect. The system validates this code and exchanges it for a token.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="redirect_uri" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">redirect_uri</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">redirect_uri=https://hostname.example.com:2087/</span></div><div><div html="<p>The redirect URI query argument that the system sent to the initial OAuth2 authentication endpoint.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The redirect URI query argument that the system sent to the initial OAuth2 authentication endpoint.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/ticket_validate_oauth2_code</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ticket_validate_oauth2_code</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" 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">URL</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"><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:2087/cpsess##########/json-api/ticket_validate_oauth2_code?api.version=1&code=84b1a729-63e3-11e6-a0fb-bfcf357fd76d&redirect_uri=https%3a%2f%2fhostname.example.com%3a2087%2f</span></span></pre></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ 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">"metadata"</span>: <button class="collapser" aria-label="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">"ticket_validate_oauth2_code"</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/cPCloud" data-section-id="tag/cPCloud" 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/cPCloud" aria-label="tag/cPCloud"></a>cPCloud</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>cPCloud Service related WHM API 1 functions.</p>
"><p>cPCloud Service related WHM API 1 functions.</p>
</div></div></div><div id="tag/Customizations" data-section-id="tag/Customizations" 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/Customizations" aria-label="tag/Customizations"></a>Customizations</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>The Customizations module for WHM API 1.</p>
"><p>The Customizations module for WHM API 1.</p>
</div></div></div><div id="tag/Customizations/operation/retrieve_customizations" data-section-id="tag/Customizations/operation/retrieve_customizations" class="sc-dntaoT ceciOs"><div data-section-id="operation/retrieve_customizations" id="operation/retrieve_customizations" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Customizations/operation/retrieve_customizations" aria-label="tag/Customizations/operation/retrieve_customizations"></a>Retrieve customization data<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves customization data.</p>
<p>Customization data includes brand logos and colors.</p>
<p>This function is used to retrieve customization data for the Jupiter theme <strong>only</strong>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves customization data.</p>
<p>Customization data includes brand logos and colors.</p>
<p>This function is used to retrieve customization data for the Jupiter theme <strong>only</strong>.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="application" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">application</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"webmail"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">application=cpanel</span></div><div><div html="<p>The application name for the customization.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application name for the customization.</p>
</div></div></div></td></tr><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 for the customization.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The theme for the customization.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/retrieve_customizations</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/retrieve_customizations</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riir5q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riir5q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riir5q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riir5q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riir5q:0" aria-labelledby="tab:Riir5q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
retrieve_customizations <span class="token punctuation">\</span>
<span class="token assign-left variable">application</span><span class="token operator">=</span><span class="token string">'cpanel'</span> <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:Riir5q:1" aria-labelledby="tab:Riir5q: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:Rjir5q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjir5q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjir5q:0" aria-labelledby="tab:Rjir5q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"retrieve_customizations"</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/Customizations/operation/update_customizations" data-section-id="tag/Customizations/operation/update_customizations" class="sc-dntaoT ceciOs"><div data-section-id="operation/update_customizations" id="operation/update_customizations" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Customizations/operation/update_customizations" aria-label="tag/Customizations/operation/update_customizations"></a>Update customization data<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function supplies branding data for a specific application and theme.</p>
<p>Customization data includes brand logos and colors.</p>
<p>This function is used to save customization data for the Jupiter theme <strong>only</strong>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function supplies branding data for a specific application and theme.</p>
<p>Customization data includes brand logos and colors.</p>
<p>This function is used to save customization data for the Jupiter theme <strong>only</strong>.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="application" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">application</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"webmail"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">application=cpanel</span></div><div><div html="<p>The application name for the customization.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application name for the customization.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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">data={"brand":{"colors":{"accent":"#00FF00","primary":"#961218"},"favicon":"AAABAAEAICACAAEAAQAwAQAAFgAAACgAAAAgAAAAQAAAAAEAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACanZoAAAAAAP///////////////////////////AD//+Ag///AEH//gDB//4AQf/+AuCq/AfAgBwP4IA8H+BABA/gQAwH8EAGArA/AgAQPwMACD+DAAAfA+AIPwP1UBQH//gAB//8AAf//gAP//wAH//+iP//////////////////////////////////////////////////////8AP//4CD//8AQf/+AMH//gBB//4C4Kr8B8CAHA/ggDwf4EAED+BADAfwQAYCsD8CABA/AwAIP4MAAB8D4Ag/A/VQFAf/+AAH//wAB//+AA///AAf//6I///////////////////////////8=","logo":{"description":"The orange logo for cPanel.","forDarkBackground":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDIwLjAuMCwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA5NCAyMCIgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgOTQgMjA7IiB4bWw6c3BhY2U9InByZXNlcnZlIj4KPHN0eWxlIHR5cGU9InRleHQvY3NzIj4KCS5zdDB7ZmlsbDojRkZGRkZGO30KPC9zdHlsZT4KPHRpdGxlPmNQYW5lbCBMb2dvIC0gV2hpdGU8L3RpdGxlPgo8ZyBpZD0iTGF5ZXJfMiI+Cgk8ZyBpZD0iTGF5ZXJfMS0yIj4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNy44LDQuOWg1LjlsLTAuOSwzLjNjLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNEg3LjljLTAuNiwwLTEuMiwwLjItMS43LDAuNQoJCQljLTAuNSwwLjQtMC44LDAuOS0xLDEuNGMtMC4xLDAuNC0wLjEsMC45LDAsMS4zYzAuMSwwLjQsMC4zLDAuNywwLjUsMS4xYzAuMiwwLjMsMC42LDAuNiwwLjksMC43QzcsMTUsNy41LDE1LjEsNy45LDE1LjFoMS43CgkJCWMwLjMsMCwwLjYsMC4xLDAuOCwwLjRjMC4yLDAuMiwwLjMsMC41LDAuMiwwLjhsLTEsMy43SDcuNmMtMS4yLDAtMi40LTAuMy0zLjQtMC44Yy0xLTAuNS0xLjktMS4yLTIuNi0yLjEKCQkJYy0xLjQtMS44LTEuOS00LjItMS4zLTYuNGwwLjEtMC40YzAuNC0xLjYsMS40LTIuOSwyLjctMy45QzMuOCw2LDQuNSw1LjYsNS4zLDUuM0M2LjEsNS4xLDYuOSw0LjksNy44LDQuOXoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNMTAuNywyMGw1LjEtMTguNGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMUMxNywwLjEsMTcuNSwwLDE4LDBoNS40YzEuMiwwLDIuNCwwLjMsMy40LDAuOGMyLjEsMSwzLjUsMi45LDQsNQoJCQljMC4zLDEuMSwwLjIsMi4zLTAuMSwzLjRsLTAuMSwwLjRjLTAuMiwwLjgtMC42LDEuNS0xLDIuMmMtMS40LDItMy44LDMuMy02LjMsMy4zaC00LjdsMC45LTMuNGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMQoJCQljMC40LTAuMywwLjgtMC40LDEuMy0wLjRoMS41YzEuMiwwLDIuMy0wLjgsMi43LTJjMC4xLTAuNCwwLjEtMC44LDAtMS4yYy0wLjEtMC40LTAuMy0wLjctMC41LTEuMWMtMC4yLTAuMy0wLjYtMC42LTAuOS0wLjcKCQkJQzI0LDUsMjMuNiw0LjksMjMuMSw0LjloLTIuOWwtMy44LDEzLjZjLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNEgxMC43eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00My4xLDEwLjJsMC4xLTAuM2MwLTAuMSwwLTAuMi0wLjEtMC4zYy0wLjEtMC4xLTAuMi0wLjEtMC4zLTAuMWgtOC40Yy0wLjMsMC0wLjctMC4xLTEtMC4yCgkJCWMtMC4zLTAuMS0wLjUtMC4zLTAuNy0wLjZjLTAuMi0wLjItMC4zLTAuNS0wLjQtMC44Yy0wLjEtMC4zLTAuMS0wLjcsMC0xbDAuNS0xLjloMTEuNGMwLjcsMCwxLjMsMC4xLDEuOSwwLjQKCQkJYzAuNiwwLjMsMS4xLDAuNywxLjUsMS4yYzAuNCwwLjUsMC43LDEuMSwwLjgsMS43YzAuMSwwLjYsMC4xLDEuMywwLDEuOWwtMi4xLDcuM0M0NiwxOSw0NC42LDIwLDQzLDIwbC04LjQsMAoJCQljLTEuNCwwLTIuNy0wLjYtMy42LTEuN2MtMC40LTAuNS0wLjctMS4xLTAuOC0xLjdjLTAuMi0wLjctMC4xLTEuNCwwLjEtMmwwLjEtMC40YzAuMS0wLjUsMC4zLTAuOSwwLjYtMS4zYzAuMy0wLjQsMC42LTAuNywxLTEKCQkJYzAuNC0wLjMsMC44LTAuNSwxLjMtMC43YzAuNS0wLjIsMS0wLjIsMS41LTAuMmg3LjFsLTAuNSwxLjljLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNGgtMy4yCgkJCWMtMC4zLDAtMC41LDAuMS0wLjYsMC40Yy0wLjEsMC4yLDAsMC40LDAuMSwwLjVjMC4xLDAuMSwwLjMsMC4yLDAuNSwwLjJoNS4xYzAuMiwwLDAuNCwwLDAuNS0wLjFjMC4xLTAuMSwwLjItMC4yLDAuMy0wLjQKCQkJbDAuMS0wLjJMNDMuMSwxMC4yeiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik01OC4zLDQuOWMxLjIsMCwyLjQsMC4zLDMuNSwwLjhjMSwwLjUsMS45LDEuMiwyLjYsMi4xYzAuNywwLjksMS4yLDEuOSwxLjQsM2MwLjMsMS4xLDAuMiwyLjMtMC4xLDMuNAoJCQlsLTEuMyw0LjdjLTAuMSwwLjMtMC4zLDAuNi0wLjYsMC44Yy0wLjMsMC4yLTAuNiwwLjMtMSwwLjNINjBjLTAuNSwwLTEtMC40LTEtMC45YzAtMC4xLDAtMC4yLDAtMC4zbDEuNi01LjcKCQkJYzAuMS0wLjQsMC4xLTAuOCwwLTEuMmMtMC4xLTAuNC0wLjMtMC43LTAuNS0xLjFjLTAuMi0wLjMtMC42LTAuNi0wLjktMC43Yy0wLjQtMC4yLTAuOC0wLjMtMS4yLTAuM2gtMi45bC0yLjUsOS4xCgkJCWMtMC4xLDAuMy0wLjMsMC42LTAuNiwwLjhjLTAuMywwLjItMC42LDAuMy0xLDAuM2gtMi44Yy0wLjMsMC0wLjYtMC4xLTAuOC0wLjRjLTAuMi0wLjItMC4zLTAuNS0wLjItMC44bDMuOC0xMy45TDU4LjMsNC45eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik03My42LDkuN2MtMC4yLDAuMi0wLjQsMC40LTAuNCwwLjZMNzIsMTQuNWMtMC4xLDAuNCwwLjEsMC44LDAuNSwwLjljMC4xLDAsMC4xLDAsMC4yLDBoMTAuOGwtMC44LDMKCQkJYy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMUM4MS41LDE5LjksODEsMjAsODAuNiwyMGgtOS44Yy0wLjcsMC0xLjMtMC4xLTEuOS0wLjRjLTAuNi0wLjMtMS4xLTAuNy0xLjUtMS4yCgkJCWMtMC40LTAuNS0wLjctMS4xLTAuOC0xLjdjLTAuMS0wLjYtMC4xLTEuMywwLjEtMS45bDEuNi01LjdjMC4yLTAuNiwwLjQtMS4yLDAuOC0xLjdjMC43LTEsMS43LTEuOCwyLjktMi4yCgkJCWMwLjYtMC4yLDEuMy0wLjMsMS45LTAuM2g2LjljMC43LDAsMS4zLDAuMSwxLjksMC40YzAuNiwwLjMsMS4xLDAuNywxLjUsMS4yQzg0LjYsNyw4NC45LDcuNiw4NSw4LjJjMC4xLDAuNiwwLjEsMS4zLTAuMSwxLjkKCQkJbC0wLjUsMS43Yy0wLjIsMC43LTAuNiwxLjQtMS4zLDEuOGMtMC42LDAuNS0xLjQsMC43LTIuMSwwLjdoLTcuOGwwLjUtMS44YzAuMS0wLjQsMC40LTAuOCwwLjgtMS4xYzAuNC0wLjMsMC44LTAuNCwxLjMtMC40SDc5CgkJCWMwLjMsMCwwLjUtMC4xLDAuNi0wLjRsMC4xLTAuNGMwLjEtMC4zLTAuMS0wLjYtMC40LTAuN2MwLDAtMC4xLDAtMC4xLDBoLTQuOEM3NCw5LjQsNzMuOCw5LjUsNzMuNiw5Ljd6Ii8+CgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTgzLjUsMjBsNS4yLTE4LjljMC4xLTAuMywwLjMtMC42LDAuNi0wLjhjMC4zLTAuMiwwLjYtMC4zLDEtMC4zSDkzYzAuMywwLDAuNiwwLjEsMC44LDAuNAoJCQlDOTQsMC42LDk0LjEsMC45LDk0LDEuMmwtMy45LDEzLjljLTAuMiwwLjctMC41LDEuNC0wLjksMmMtMC40LDAuNi0wLjksMS4xLTEuNSwxLjVjLTAuNiwwLjQtMS4yLDAuOC0xLjksMQoJCQlDODUsMTkuOSw4NC4yLDIwLDgzLjUsMjB6Ii8+Cgk8L2c+CjwvZz4KPC9zdmc+","forLightBackground":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDIwLjAuMCwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9InhMYXllcl8xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4PSIwcHgiIHk9IjBweCIKCSB2aWV3Qm94PSIwIDAgOTQgMjAiIHN0eWxlPSJlbmFibGUtYmFja2dyb3VuZDpuZXcgMCAwIDk0IDIwOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI+CjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI+Cgkuc3Qwe2ZpbGw6I0ZGNkMyQzt9Cjwvc3R5bGU+Cjx0aXRsZT5jUGFuZWwgTG9nbyAtIE9yYW5nZTwvdGl0bGU+CjxnIGlkPSJ4TGF5ZXJfMiI+Cgk8ZyBpZD0ieExheWVyXzEtMiI+CgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTcuOCw0LjloNS45bC0wLjksMy4zYy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRINy45Yy0wLjYsMC0xLjIsMC4yLTEuNywwLjUKCQkJYy0wLjUsMC40LTAuOCwwLjktMSwxLjRjLTAuMSwwLjQtMC4xLDAuOSwwLDEuM2MwLjEsMC40LDAuMywwLjcsMC41LDEuMWMwLjIsMC4zLDAuNiwwLjYsMC45LDAuN0M3LDE1LDcuNSwxNS4xLDcuOSwxNS4xaDEuNwoJCQljMC4zLDAsMC42LDAuMSwwLjgsMC40YzAuMiwwLjIsMC4zLDAuNSwwLjIsMC44bC0xLDMuN0g3LjZjLTEuMiwwLTIuNC0wLjMtMy40LTAuOGMtMS0wLjUtMS45LTEuMi0yLjYtMi4xCgkJCWMtMS40LTEuOC0xLjktNC4yLTEuMy02LjRsMC4xLTAuNGMwLjQtMS42LDEuNC0yLjksMi43LTMuOUMzLjgsNiw0LjUsNS42LDUuMyw1LjNDNi4xLDUuMSw2LjksNC45LDcuOCw0Ljl6Ii8+CgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTEwLjcsMjBsNS4xLTE4LjRjMC4xLTAuNCwwLjQtMC44LDAuOC0xLjFDMTcsMC4xLDE3LjUsMCwxOCwwaDUuNGMxLjIsMCwyLjQsMC4zLDMuNCwwLjhjMi4xLDEsMy41LDIuOSw0LDUKCQkJYzAuMywxLjEsMC4yLDIuMy0wLjEsMy40bC0wLjEsMC40Yy0wLjIsMC44LTAuNiwxLjUtMSwyLjJjLTEuNCwyLTMuOCwzLjMtNi4zLDMuM2gtNC43bDAuOS0zLjRjMC4xLTAuNCwwLjQtMC44LDAuOC0xLjEKCQkJYzAuNC0wLjMsMC44LTAuNCwxLjMtMC40aDEuNWMxLjIsMCwyLjMtMC44LDIuNy0yYzAuMS0wLjQsMC4xLTAuOCwwLTEuMmMtMC4xLTAuNC0wLjMtMC43LTAuNS0xLjFjLTAuMi0wLjMtMC42LTAuNi0wLjktMC43CgkJCUMyNCw1LDIzLjYsNC45LDIzLjEsNC45aC0yLjlsLTMuOCwxMy42Yy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRIMTAuN3oiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDMuMSwxMC4ybDAuMS0wLjNjMC0wLjEsMC0wLjItMC4xLTAuM2MtMC4xLTAuMS0wLjItMC4xLTAuMy0wLjFoLTguNGMtMC4zLDAtMC43LTAuMS0xLTAuMgoJCQljLTAuMy0wLjEtMC41LTAuMy0wLjctMC42Yy0wLjItMC4yLTAuMy0wLjUtMC40LTAuOGMtMC4xLTAuMy0wLjEtMC43LDAtMWwwLjUtMS45aDExLjRjMC43LDAsMS4zLDAuMSwxLjksMC40CgkJCWMwLjYsMC4zLDEuMSwwLjcsMS41LDEuMmMwLjQsMC41LDAuNywxLjEsMC44LDEuN2MwLjEsMC42LDAuMSwxLjMsMCwxLjlsLTIuMSw3LjNDNDYsMTksNDQuNiwyMCw0MywyMGwtOC40LDAKCQkJYy0xLjQsMC0yLjctMC42LTMuNi0xLjdjLTAuNC0wLjUtMC43LTEuMS0wLjgtMS43Yy0wLjItMC43LTAuMS0xLjQsMC4xLTJsMC4xLTAuNGMwLjEtMC41LDAuMy0wLjksMC42LTEuM2MwLjMtMC40LDAuNi0wLjcsMS0xCgkJCWMwLjQtMC4zLDAuOC0wLjUsMS4zLTAuN2MwLjUtMC4yLDEtMC4yLDEuNS0wLjJoNy4xbC0wLjUsMS45Yy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRoLTMuMgoJCQljLTAuMywwLTAuNSwwLjEtMC42LDAuNGMtMC4xLDAuMiwwLDAuNCwwLjEsMC41YzAuMSwwLjEsMC4zLDAuMiwwLjUsMC4yaDUuMWMwLjIsMCwwLjQsMCwwLjUtMC4xYzAuMS0wLjEsMC4yLTAuMiwwLjMtMC40CgkJCWwwLjEtMC4yTDQzLjEsMTAuMnoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNTguMyw0LjljMS4yLDAsMi40LDAuMywzLjUsMC44YzEsMC41LDEuOSwxLjIsMi42LDIuMWMwLjcsMC45LDEuMiwxLjksMS40LDNjMC4zLDEuMSwwLjIsMi4zLTAuMSwzLjQKCQkJbC0xLjMsNC43Yy0wLjEsMC4zLTAuMywwLjYtMC42LDAuOGMtMC4zLDAuMi0wLjYsMC4zLTEsMC4zSDYwYy0wLjUsMC0xLTAuNC0xLTAuOWMwLTAuMSwwLTAuMiwwLTAuM2wxLjYtNS43CgkJCWMwLjEtMC40LDAuMS0wLjgsMC0xLjJjLTAuMS0wLjQtMC4zLTAuNy0wLjUtMS4xYy0wLjItMC4zLTAuNi0wLjYtMC45LTAuN2MtMC40LTAuMi0wLjgtMC4zLTEuMi0wLjNoLTIuOWwtMi41LDkuMQoJCQljLTAuMSwwLjMtMC4zLDAuNi0wLjYsMC44Yy0wLjMsMC4yLTAuNiwwLjMtMSwwLjNoLTIuOGMtMC4zLDAtMC42LTAuMS0wLjgtMC40Yy0wLjItMC4yLTAuMy0wLjUtMC4yLTAuOGwzLjgtMTMuOUw1OC4zLDQuOXoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNzMuNiw5LjdjLTAuMiwwLjItMC40LDAuNC0wLjQsMC42TDcyLDE0LjVjLTAuMSwwLjQsMC4xLDAuOCwwLjUsMC45YzAuMSwwLDAuMSwwLDAuMiwwaDEwLjhsLTAuOCwzCgkJCWMtMC4xLDAuNC0wLjQsMC44LTAuOCwxLjFDODEuNSwxOS45LDgxLDIwLDgwLjYsMjBoLTkuOGMtMC43LDAtMS4zLTAuMS0xLjktMC40Yy0wLjYtMC4zLTEuMS0wLjctMS41LTEuMgoJCQljLTAuNC0wLjUtMC43LTEuMS0wLjgtMS43Yy0wLjEtMC42LTAuMS0xLjMsMC4xLTEuOWwxLjYtNS43YzAuMi0wLjYsMC40LTEuMiwwLjgtMS43YzAuNy0xLDEuNy0xLjgsMi45LTIuMgoJCQljMC42LTAuMiwxLjMtMC4zLDEuOS0wLjNoNi45YzAuNywwLDEuMywwLjEsMS45LDAuNGMwLjYsMC4zLDEuMSwwLjcsMS41LDEuMkM4NC42LDcsODQuOSw3LjYsODUsOC4yYzAuMSwwLjYsMC4xLDEuMy0wLjEsMS45CgkJCWwtMC41LDEuN2MtMC4yLDAuNy0wLjYsMS40LTEuMywxLjhjLTAuNiwwLjUtMS40LDAuNy0yLjEsMC43aC03LjhsMC41LTEuOGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMWMwLjQtMC4zLDAuOC0wLjQsMS4zLTAuNEg3OQoJCQljMC4zLDAsMC41LTAuMSwwLjYtMC40bDAuMS0wLjRjMC4xLTAuMy0wLjEtMC42LTAuNC0wLjdjMCwwLTAuMSwwLTAuMSwwaC00LjhDNzQsOS40LDczLjgsOS41LDczLjYsOS43eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik04My41LDIwbDUuMi0xOC45YzAuMS0wLjMsMC4zLTAuNiwwLjYtMC44YzAuMy0wLjIsMC42LTAuMywxLTAuM0g5M2MwLjMsMCwwLjYsMC4xLDAuOCwwLjQKCQkJQzk0LDAuNiw5NC4xLDAuOSw5NCwxLjJsLTMuOSwxMy45Yy0wLjIsMC43LTAuNSwxLjQtMC45LDJjLTAuNCwwLjYtMC45LDEuMS0xLjUsMS41Yy0wLjYsMC40LTEuMiwwLjgtMS45LDEKCQkJQzg1LDE5LjksODQuMiwyMCw4My41LDIweiIvPgoJPC9nPgo8L2c+Cjwvc3ZnPgo="}},"documentation":{"url":"https://hosting.com/documentation"},"help":{"url":"https://hosting.com/get-help"}}</span></div><div><div html="<p>The theme data to save.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The theme data to save.</p>
</div></div></div></td></tr><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"> <!-- -->Value<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"jupiter"</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 for the customization.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The theme name for the customization.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/update_customizations</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/update_customizations</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijb5q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijb5q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijb5q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijb5q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijb5q:0" aria-labelledby="tab:Rijb5q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
update_customizations <span class="token punctuation">\</span>
<span class="token assign-left variable">application</span><span class="token operator">=</span><span class="token string">'cpanel'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">theme</span><span class="token operator">=</span><span class="token string">'jupiter'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">data</span><span class="token operator">=</span><span class="token string">'{"brand":{"colors":{"accent":"#00FF00","primary":"#961218"},"favicon":"AAABAAEAICACAAEAAQAwAQAAFgAAACgAAAAgAAAAQAAAAAEAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACanZoAAAAAAP%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FAD%2F%2F%2BAg%2F%2F%2FAEH%2F%2FgDB%2F%2F4AQf%2F%2BAuCq%2FAfAgBwP4IA8H%2BBABA%2FgQAwH8EAGArA%2FAgAQPwMACD%2BDAAAfA%2BAIPwP1UBQH%2F%2FgAB%2F%2F8AAf%2F%2FgAP%2F%2FwAH%2F%2F%2BiP%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8AP%2F%2F4CD%2F%2F8AQf%2F%2BAMH%2F%2FgBB%2F%2F4C4Kr8B8CAHA%2FggDwf4EAED%2BBADAfwQAYCsD8CABA%2FAwAIP4MAAB8D4Ag%2FA%2FVQFAf%2F%2BAAH%2F%2FwAB%2F%2F%2BAA%2F%2F%2FAAf%2F%2F6I%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8%3D","logo":{"description":"The orange logo for cPanel.","forDarkBackground":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDIwLjAuMCwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA5NCAyMCIgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgOTQgMjA7IiB4bWw6c3BhY2U9InByZXNlcnZlIj4KPHN0eWxlIHR5cGU9InRleHQvY3NzIj4KCS5zdDB7ZmlsbDojRkZGRkZGO30KPC9zdHlsZT4KPHRpdGxlPmNQYW5lbCBMb2dvIC0gV2hpdGU8L3RpdGxlPgo8ZyBpZD0iTGF5ZXJfMiI%2BCgk8ZyBpZD0iTGF5ZXJfMS0yIj4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNy44LDQuOWg1LjlsLTAuOSwzLjNjLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNEg3LjljLTAuNiwwLTEuMiwwLjItMS43LDAuNQoJCQljLTAuNSwwLjQtMC44LDAuOS0xLDEuNGMtMC4xLDAuNC0wLjEsMC45LDAsMS4zYzAuMSwwLjQsMC4zLDAuNywwLjUsMS4xYzAuMiwwLjMsMC42LDAuNiwwLjksMC43QzcsMTUsNy41LDE1LjEsNy45LDE1LjFoMS43CgkJCWMwLjMsMCwwLjYsMC4xLDAuOCwwLjRjMC4yLDAuMiwwLjMsMC41LDAuMiwwLjhsLTEsMy43SDcuNmMtMS4yLDAtMi40LTAuMy0zLjQtMC44Yy0xLTAuNS0xLjktMS4yLTIuNi0yLjEKCQkJYy0xLjQtMS44LTEuOS00LjItMS4zLTYuNGwwLjEtMC40YzAuNC0xLjYsMS40LTIuOSwyLjctMy45QzMuOCw2LDQuNSw1LjYsNS4zLDUuM0M2LjEsNS4xLDYuOSw0LjksNy44LDQuOXoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNMTAuNywyMGw1LjEtMTguNGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMUMxNywwLjEsMTcuNSwwLDE4LDBoNS40YzEuMiwwLDIuNCwwLjMsMy40LDAuOGMyLjEsMSwzLjUsMi45LDQsNQoJCQljMC4zLDEuMSwwLjIsMi4zLTAuMSwzLjRsLTAuMSwwLjRjLTAuMiwwLjgtMC42LDEuNS0xLDIuMmMtMS40LDItMy44LDMuMy02LjMsMy4zaC00LjdsMC45LTMuNGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMQoJCQljMC40LTAuMywwLjgtMC40LDEuMy0wLjRoMS41YzEuMiwwLDIuMy0wLjgsMi43LTJjMC4xLTAuNCwwLjEtMC44LDAtMS4yYy0wLjEtMC40LTAuMy0wLjctMC41LTEuMWMtMC4yLTAuMy0wLjYtMC42LTAuOS0wLjcKCQkJQzI0LDUsMjMuNiw0LjksMjMuMSw0LjloLTIuOWwtMy44LDEzLjZjLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNEgxMC43eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00My4xLDEwLjJsMC4xLTAuM2MwLTAuMSwwLTAuMi0wLjEtMC4zYy0wLjEtMC4xLTAuMi0wLjEtMC4zLTAuMWgtOC40Yy0wLjMsMC0wLjctMC4xLTEtMC4yCgkJCWMtMC4zLTAuMS0wLjUtMC4zLTAuNy0wLjZjLTAuMi0wLjItMC4zLTAuNS0wLjQtMC44Yy0wLjEtMC4zLTAuMS0wLjcsMC0xbDAuNS0xLjloMTEuNGMwLjcsMCwxLjMsMC4xLDEuOSwwLjQKCQkJYzAuNiwwLjMsMS4xLDAuNywxLjUsMS4yYzAuNCwwLjUsMC43LDEuMSwwLjgsMS43YzAuMSwwLjYsMC4xLDEuMywwLDEuOWwtMi4xLDcuM0M0NiwxOSw0NC42LDIwLDQzLDIwbC04LjQsMAoJCQljLTEuNCwwLTIuNy0wLjYtMy42LTEuN2MtMC40LTAuNS0wLjctMS4xLTAuOC0xLjdjLTAuMi0wLjctMC4xLTEuNCwwLjEtMmwwLjEtMC40YzAuMS0wLjUsMC4zLTAuOSwwLjYtMS4zYzAuMy0wLjQsMC42LTAuNywxLTEKCQkJYzAuNC0wLjMsMC44LTAuNSwxLjMtMC43YzAuNS0wLjIsMS0wLjIsMS41LTAuMmg3LjFsLTAuNSwxLjljLTAuMSwwLjQtMC40LDAuOC0wLjgsMS4xYy0wLjQsMC4zLTAuOCwwLjQtMS4zLDAuNGgtMy4yCgkJCWMtMC4zLDAtMC41LDAuMS0wLjYsMC40Yy0wLjEsMC4yLDAsMC40LDAuMSwwLjVjMC4xLDAuMSwwLjMsMC4yLDAuNSwwLjJoNS4xYzAuMiwwLDAuNCwwLDAuNS0wLjFjMC4xLTAuMSwwLjItMC4yLDAuMy0wLjQKCQkJbDAuMS0wLjJMNDMuMSwxMC4yeiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik01OC4zLDQuOWMxLjIsMCwyLjQsMC4zLDMuNSwwLjhjMSwwLjUsMS45LDEuMiwyLjYsMi4xYzAuNywwLjksMS4yLDEuOSwxLjQsM2MwLjMsMS4xLDAuMiwyLjMtMC4xLDMuNAoJCQlsLTEuMyw0LjdjLTAuMSwwLjMtMC4zLDAuNi0wLjYsMC44Yy0wLjMsMC4yLTAuNiwwLjMtMSwwLjNINjBjLTAuNSwwLTEtMC40LTEtMC45YzAtMC4xLDAtMC4yLDAtMC4zbDEuNi01LjcKCQkJYzAuMS0wLjQsMC4xLTAuOCwwLTEuMmMtMC4xLTAuNC0wLjMtMC43LTAuNS0xLjFjLTAuMi0wLjMtMC42LTAuNi0wLjktMC43Yy0wLjQtMC4yLTAuOC0wLjMtMS4yLTAuM2gtMi45bC0yLjUsOS4xCgkJCWMtMC4xLDAuMy0wLjMsMC42LTAuNiwwLjhjLTAuMywwLjItMC42LDAuMy0xLDAuM2gtMi44Yy0wLjMsMC0wLjYtMC4xLTAuOC0wLjRjLTAuMi0wLjItMC4zLTAuNS0wLjItMC44bDMuOC0xMy45TDU4LjMsNC45eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik03My42LDkuN2MtMC4yLDAuMi0wLjQsMC40LTAuNCwwLjZMNzIsMTQuNWMtMC4xLDAuNCwwLjEsMC44LDAuNSwwLjljMC4xLDAsMC4xLDAsMC4yLDBoMTAuOGwtMC44LDMKCQkJYy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMUM4MS41LDE5LjksODEsMjAsODAuNiwyMGgtOS44Yy0wLjcsMC0xLjMtMC4xLTEuOS0wLjRjLTAuNi0wLjMtMS4xLTAuNy0xLjUtMS4yCgkJCWMtMC40LTAuNS0wLjctMS4xLTAuOC0xLjdjLTAuMS0wLjYtMC4xLTEuMywwLjEtMS45bDEuNi01LjdjMC4yLTAuNiwwLjQtMS4yLDAuOC0xLjdjMC43LTEsMS43LTEuOCwyLjktMi4yCgkJCWMwLjYtMC4yLDEuMy0wLjMsMS45LTAuM2g2LjljMC43LDAsMS4zLDAuMSwxLjksMC40YzAuNiwwLjMsMS4xLDAuNywxLjUsMS4yQzg0LjYsNyw4NC45LDcuNiw4NSw4LjJjMC4xLDAuNiwwLjEsMS4zLTAuMSwxLjkKCQkJbC0wLjUsMS43Yy0wLjIsMC43LTAuNiwxLjQtMS4zLDEuOGMtMC42LDAuNS0xLjQsMC43LTIuMSwwLjdoLTcuOGwwLjUtMS44YzAuMS0wLjQsMC40LTAuOCwwLjgtMS4xYzAuNC0wLjMsMC44LTAuNCwxLjMtMC40SDc5CgkJCWMwLjMsMCwwLjUtMC4xLDAuNi0wLjRsMC4xLTAuNGMwLjEtMC4zLTAuMS0wLjYtMC40LTAuN2MwLDAtMC4xLDAtMC4xLDBoLTQuOEM3NCw5LjQsNzMuOCw5LjUsNzMuNiw5Ljd6Ii8%2BCgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTgzLjUsMjBsNS4yLTE4LjljMC4xLTAuMywwLjMtMC42LDAuNi0wLjhjMC4zLTAuMiwwLjYtMC4zLDEtMC4zSDkzYzAuMywwLDAuNiwwLjEsMC44LDAuNAoJCQlDOTQsMC42LDk0LjEsMC45LDk0LDEuMmwtMy45LDEzLjljLTAuMiwwLjctMC41LDEuNC0wLjksMmMtMC40LDAuNi0wLjksMS4xLTEuNSwxLjVjLTAuNiwwLjQtMS4yLDAuOC0xLjksMQoJCQlDODUsMTkuOSw4NC4yLDIwLDgzLjUsMjB6Ii8%2BCgk8L2c%2BCjwvZz4KPC9zdmc%2B","forLightBackground":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDIwLjAuMCwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9InhMYXllcl8xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4PSIwcHgiIHk9IjBweCIKCSB2aWV3Qm94PSIwIDAgOTQgMjAiIHN0eWxlPSJlbmFibGUtYmFja2dyb3VuZDpuZXcgMCAwIDk0IDIwOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGNkMyQzt9Cjwvc3R5bGU%2BCjx0aXRsZT5jUGFuZWwgTG9nbyAtIE9yYW5nZTwvdGl0bGU%2BCjxnIGlkPSJ4TGF5ZXJfMiI%2BCgk8ZyBpZD0ieExheWVyXzEtMiI%2BCgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTcuOCw0LjloNS45bC0wLjksMy4zYy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRINy45Yy0wLjYsMC0xLjIsMC4yLTEuNywwLjUKCQkJYy0wLjUsMC40LTAuOCwwLjktMSwxLjRjLTAuMSwwLjQtMC4xLDAuOSwwLDEuM2MwLjEsMC40LDAuMywwLjcsMC41LDEuMWMwLjIsMC4zLDAuNiwwLjYsMC45LDAuN0M3LDE1LDcuNSwxNS4xLDcuOSwxNS4xaDEuNwoJCQljMC4zLDAsMC42LDAuMSwwLjgsMC40YzAuMiwwLjIsMC4zLDAuNSwwLjIsMC44bC0xLDMuN0g3LjZjLTEuMiwwLTIuNC0wLjMtMy40LTAuOGMtMS0wLjUtMS45LTEuMi0yLjYtMi4xCgkJCWMtMS40LTEuOC0xLjktNC4yLTEuMy02LjRsMC4xLTAuNGMwLjQtMS42LDEuNC0yLjksMi43LTMuOUMzLjgsNiw0LjUsNS42LDUuMyw1LjNDNi4xLDUuMSw2LjksNC45LDcuOCw0Ljl6Ii8%2BCgkJPHBhdGggY2xhc3M9InN0MCIgZD0iTTEwLjcsMjBsNS4xLTE4LjRjMC4xLTAuNCwwLjQtMC44LDAuOC0xLjFDMTcsMC4xLDE3LjUsMCwxOCwwaDUuNGMxLjIsMCwyLjQsMC4zLDMuNCwwLjhjMi4xLDEsMy41LDIuOSw0LDUKCQkJYzAuMywxLjEsMC4yLDIuMy0wLjEsMy40bC0wLjEsMC40Yy0wLjIsMC44LTAuNiwxLjUtMSwyLjJjLTEuNCwyLTMuOCwzLjMtNi4zLDMuM2gtNC43bDAuOS0zLjRjMC4xLTAuNCwwLjQtMC44LDAuOC0xLjEKCQkJYzAuNC0wLjMsMC44LTAuNCwxLjMtMC40aDEuNWMxLjIsMCwyLjMtMC44LDIuNy0yYzAuMS0wLjQsMC4xLTAuOCwwLTEuMmMtMC4xLTAuNC0wLjMtMC43LTAuNS0xLjFjLTAuMi0wLjMtMC42LTAuNi0wLjktMC43CgkJCUMyNCw1LDIzLjYsNC45LDIzLjEsNC45aC0yLjlsLTMuOCwxMy42Yy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRIMTAuN3oiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDMuMSwxMC4ybDAuMS0wLjNjMC0wLjEsMC0wLjItMC4xLTAuM2MtMC4xLTAuMS0wLjItMC4xLTAuMy0wLjFoLTguNGMtMC4zLDAtMC43LTAuMS0xLTAuMgoJCQljLTAuMy0wLjEtMC41LTAuMy0wLjctMC42Yy0wLjItMC4yLTAuMy0wLjUtMC40LTAuOGMtMC4xLTAuMy0wLjEtMC43LDAtMWwwLjUtMS45aDExLjRjMC43LDAsMS4zLDAuMSwxLjksMC40CgkJCWMwLjYsMC4zLDEuMSwwLjcsMS41LDEuMmMwLjQsMC41LDAuNywxLjEsMC44LDEuN2MwLjEsMC42LDAuMSwxLjMsMCwxLjlsLTIuMSw3LjNDNDYsMTksNDQuNiwyMCw0MywyMGwtOC40LDAKCQkJYy0xLjQsMC0yLjctMC42LTMuNi0xLjdjLTAuNC0wLjUtMC43LTEuMS0wLjgtMS43Yy0wLjItMC43LTAuMS0xLjQsMC4xLTJsMC4xLTAuNGMwLjEtMC41LDAuMy0wLjksMC42LTEuM2MwLjMtMC40LDAuNi0wLjcsMS0xCgkJCWMwLjQtMC4zLDAuOC0wLjUsMS4zLTAuN2MwLjUtMC4yLDEtMC4yLDEuNS0wLjJoNy4xbC0wLjUsMS45Yy0wLjEsMC40LTAuNCwwLjgtMC44LDEuMWMtMC40LDAuMy0wLjgsMC40LTEuMywwLjRoLTMuMgoJCQljLTAuMywwLTAuNSwwLjEtMC42LDAuNGMtMC4xLDAuMiwwLDAuNCwwLjEsMC41YzAuMSwwLjEsMC4zLDAuMiwwLjUsMC4yaDUuMWMwLjIsMCwwLjQsMCwwLjUtMC4xYzAuMS0wLjEsMC4yLTAuMiwwLjMtMC40CgkJCWwwLjEtMC4yTDQzLjEsMTAuMnoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNTguMyw0LjljMS4yLDAsMi40LDAuMywzLjUsMC44YzEsMC41LDEuOSwxLjIsMi42LDIuMWMwLjcsMC45LDEuMiwxLjksMS40LDNjMC4zLDEuMSwwLjIsMi4zLTAuMSwzLjQKCQkJbC0xLjMsNC43Yy0wLjEsMC4zLTAuMywwLjYtMC42LDAuOGMtMC4zLDAuMi0wLjYsMC4zLTEsMC4zSDYwYy0wLjUsMC0xLTAuNC0xLTAuOWMwLTAuMSwwLTAuMiwwLTAuM2wxLjYtNS43CgkJCWMwLjEtMC40LDAuMS0wLjgsMC0xLjJjLTAuMS0wLjQtMC4zLTAuNy0wLjUtMS4xYy0wLjItMC4zLTAuNi0wLjYtMC45LTAuN2MtMC40LTAuMi0wLjgtMC4zLTEuMi0wLjNoLTIuOWwtMi41LDkuMQoJCQljLTAuMSwwLjMtMC4zLDAuNi0wLjYsMC44Yy0wLjMsMC4yLTAuNiwwLjMtMSwwLjNoLTIuOGMtMC4zLDAtMC42LTAuMS0wLjgtMC40Yy0wLjItMC4yLTAuMy0wLjUtMC4yLTAuOGwzLjgtMTMuOUw1OC4zLDQuOXoiLz4KCQk8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNzMuNiw5LjdjLTAuMiwwLjItMC40LDAuNC0wLjQsMC42TDcyLDE0LjVjLTAuMSwwLjQsMC4xLDAuOCwwLjUsMC45YzAuMSwwLDAuMSwwLDAuMiwwaDEwLjhsLTAuOCwzCgkJCWMtMC4xLDAuNC0wLjQsMC44LTAuOCwxLjFDODEuNSwxOS45LDgxLDIwLDgwLjYsMjBoLTkuOGMtMC43LDAtMS4zLTAuMS0xLjktMC40Yy0wLjYtMC4zLTEuMS0wLjctMS41LTEuMgoJCQljLTAuNC0wLjUtMC43LTEuMS0wLjgtMS43Yy0wLjEtMC42LTAuMS0xLjMsMC4xLTEuOWwxLjYtNS43YzAuMi0wLjYsMC40LTEuMiwwLjgtMS43YzAuNy0xLDEuNy0xLjgsMi45LTIuMgoJCQljMC42LTAuMiwxLjMtMC4zLDEuOS0wLjNoNi45YzAuNywwLDEuMywwLjEsMS45LDAuNGMwLjYsMC4zLDEuMSwwLjcsMS41LDEuMkM4NC42LDcsODQuOSw3LjYsODUsOC4yYzAuMSwwLjYsMC4xLDEuMy0wLjEsMS45CgkJCWwtMC41LDEuN2MtMC4yLDAuNy0wLjYsMS40LTEuMywxLjhjLTAuNiwwLjUtMS40LDAuNy0yLjEsMC43aC03LjhsMC41LTEuOGMwLjEtMC40LDAuNC0wLjgsMC44LTEuMWMwLjQtMC4zLDAuOC0wLjQsMS4zLTAuNEg3OQoJCQljMC4zLDAsMC41LTAuMSwwLjYtMC40bDAuMS0wLjRjMC4xLTAuMy0wLjEtMC42LTAuNC0wLjdjMCwwLTAuMSwwLTAuMSwwaC00LjhDNzQsOS40LDczLjgsOS41LDczLjYsOS43eiIvPgoJCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik04My41LDIwbDUuMi0xOC45YzAuMS0wLjMsMC4zLTAuNiwwLjYtMC44YzAuMy0wLjIsMC42LTAuMywxLTAuM0g5M2MwLjMsMCwwLjYsMC4xLDAuOCwwLjQKCQkJQzk0LDAuNiw5NC4xLDAuOSw5NCwxLjJsLTMuOSwxMy45Yy0wLjIsMC43LTAuNSwxLjQtMC45LDJjLTAuNCwwLjYtMC45LDEuMS0xLjUsMS41Yy0wLjYsMC40LTEuMiwwLjgtMS45LDEKCQkJQzg1LDE5LjksODQuMiwyMCw4My41LDIweiIvPgoJPC9nPgo8L2c%2BCjwvc3ZnPgo%3D"}},"documentation":{"url":"https://hosting.com/documentation"},"help":{"url":"https://hosting.com/get-help"}}'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijb5q:1" aria-labelledby="tab:Rijb5q: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:Rjjb5q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjb5q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjb5q:0" aria-labelledby="tab:Rjjb5q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"update_customizations"</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/Customizations/operation/delete_customizations" data-section-id="tag/Customizations/operation/delete_customizations" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_customizations" id="operation/delete_customizations" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Customizations/operation/delete_customizations" aria-label="tag/Customizations/operation/delete_customizations"></a>Delete customization data<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deletes customization data.</p>
<p>Customization data includes brand logos and colors.</p>
<p>Server owners and resellers can supply customization data to whitelabel portions
of the product or customize the cPanel experience for their users.</p>
<p>This function is used to delete customization data for the Jupiter theme <strong>only</strong>.</p>
<p>If you provide the optional <code>path</code> parameter, the API will removed only the specific element specified in the <code>.</code> separated path.
See the parameter for more details.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes customization data.</p>
<p>Customization data includes brand logos and colors.</p>
<p>Server owners and resellers can supply customization data to whitelabel portions
of the product or customize the cPanel experience for their users.</p>
<p>This function is used to delete customization data for the Jupiter theme <strong>only</strong>.</p>
<p>If you provide the optional <code>path</code> parameter, the API will removed only the specific element specified in the <code>.</code> separated path.
See the parameter for more details.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="application" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">application</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"webmail"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">application=cpanel</span></div><div><div html="<p>The application name for the customization.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application name for the customization.</p>
</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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">path=brand.icon.description</span></div><div><div html="<p>The JSONPath expression to reach to property you want to delete. We support only the
subset of JSONPath using the <code>.</code> style notation. There is presently no other JSONPath
features supported.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The JSONPath expression to reach to property you want to delete. We support only the
subset of JSONPath using the <code>.</code> style notation. There is presently no other JSONPath
features supported.</p>
</div></div></div></td></tr><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 for the customization.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The theme name for the customization.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/delete_customizations</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/delete_customizations</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijr5q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijr5q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijr5q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijr5q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijr5q:0" aria-labelledby="tab:Rijr5q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
delete_customizations <span class="token punctuation">\</span>
<span class="token assign-left variable">application</span><span class="token operator">=</span><span class="token string">'cpanel'</span> <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:Rijr5q:1" aria-labelledby="tab:Rijr5q: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:Rjjr5q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjr5q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjr5q:0" aria-labelledby="tab:Rjjr5q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"delete_customizations"</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/Manage-MySQL-Server" data-section-id="tag/Manage-MySQL-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/Manage-MySQL-Server" aria-label="tag/Manage-MySQL-Server"></a>Manage MySQL Server</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Databases / Manage MySQL Server</p>
"><p>Databases / Manage MySQL Server</p>
</div></div></div><div id="tag/Manage-MySQL-Server/operation/background_mysql_upgrade_checker_run" data-section-id="tag/Manage-MySQL-Server/operation/background_mysql_upgrade_checker_run" class="sc-dntaoT ceciOs"><div data-section-id="operation/background_mysql_upgrade_checker_run" id="operation/background_mysql_upgrade_checker_run" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-MySQL-Server/operation/background_mysql_upgrade_checker_run" aria-label="tag/Manage-MySQL-Server/operation/background_mysql_upgrade_checker_run"></a>Validate MySQL status before upgrade<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks your MySQL configuration file and table engine before an upgrade to MySQL 8.0.</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">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 checks your MySQL configuration file and table engine before an upgrade to MySQL 8.0.</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">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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/background_mysql_upgrade_checker_run</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/background_mysql_upgrade_checker_run</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99336a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99336a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99336a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99336a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99336a:0" aria-labelledby="tab:R99336a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
background_mysql_upgrade_checker_run
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99336a:1" aria-labelledby="tab:R99336a: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:R9p336a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p336a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p336a:0" aria-labelledby="tab:R9p336a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_entry"</span>: <span class="token string">"mysql_upgrade.20200202-172923"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pid"</span>: <span class="token number">23456</span></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">"command"</span>: <span class="token string">"background_mysql_upgrade_checker_run"</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/Manage-MySQL-Server/operation/current_mysql_version" data-section-id="tag/Manage-MySQL-Server/operation/current_mysql_version" class="sc-dntaoT ceciOs"><div data-section-id="operation/current_mysql_version" id="operation/current_mysql_version" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-MySQL-Server/operation/current_mysql_version" aria-label="tag/Manage-MySQL-Server/operation/current_mysql_version"></a>Return MySQL version<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the server&#39;s version of MySQL® or MariaDB®.</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 retrieves the server's version of MySQL® or MariaDB®.</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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/current_mysql_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/current_mysql_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:R99536a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99536a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99536a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99536a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99536a:0" aria-labelledby="tab:R99536a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
current_mysql_version
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99536a:1" aria-labelledby="tab:R99536a: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:R9p536a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p536a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p536a:0" aria-labelledby="tab:R9p536a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"server"</span>: <span class="token string">"mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"8.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">"metadata"</span>: <button class="collapser" aria-label="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">"current_mysql_version"</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/Manage-MySQL-Server/operation/background_mysql_upgrade_status" data-section-id="tag/Manage-MySQL-Server/operation/background_mysql_upgrade_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/background_mysql_upgrade_status" id="operation/background_mysql_upgrade_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-MySQL-Server/operation/background_mysql_upgrade_status" aria-label="tag/Manage-MySQL-Server/operation/background_mysql_upgrade_status"></a>Return MySQL or MariaDB upgrade status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the status of a background MySQL® or MariaDB® upgrade.</p>
<p><strong>Important:</strong></p>
<p> When you disable the <a href="https://go.cpanel.net/serverroles">MySQL/MariaDB</a> role 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 retrieves the status of a background MySQL® or MariaDB® upgrade.</p>
<p><strong>Important:</strong></p>
<p> When you disable the <a href="https://go.cpanel.net/serverroles">MySQL/MariaDB</a> role 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="upgrade_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">upgrade_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">upgrade_id=mysql_upgrade.20141108-172923</span></div><div><div html="<p>The logfile&#39;s name.</p>
<p><strong>Note:</strong></p>
<p> Log files exist in the <code>/var/cpanel/logs/</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The logfile's name.</p>
<p><strong>Note:</strong></p>
<p> Log files exist in the <code>/var/cpanel/logs/</code> 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/background_mysql_upgrade_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/background_mysql_upgrade_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:R99736a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99736a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99736a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99736a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99736a:0" aria-labelledby="tab:R99736a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
background_mysql_upgrade_status <span class="token punctuation">\</span>
<span class="token assign-left variable">upgrade_id</span><span class="token operator">=</span><span class="token string">'mysql_upgrade.20141108-172923'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99736a:1" aria-labelledby="tab:R99736a: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:R9p736a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p736a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p736a:0" aria-labelledby="tab:R9p736a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error_log"</span>: <span class="token string">"Starting The system failed to update MYSQL,\\n------------------------------------\\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log"</span>: <span class="token string">"Starting process with log file at /var/cpanel/logs/mysql_upgrade.20141108-172923/unattended_background_upgrade.log\nBeginning MariaDB 10.0 upgrade...\nObtained version information from system.\nEnsuring the MariaDB100 repository is available and working.\ncheckyum version 22.3\nEnsuring that the package MariaDB-client with version matching 10.0 is available.\nEnsuring that the package MariaDB-common with version matching 10.0 is available.\nEnsuring that the package MariaDB-devel with version matching 10.0 is available.\nEnsuring that the package MariaDB-server with version matching 10.0 is available.\nEnsuring that the package MariaDB-shared with version matching 10.0 is available.\nEnsuring that the package coreutils is available.\nEnsuring that the package grep is available.\nEnsuring that the package perl-DBI is available.\n your MariaDB server version for the right syntax to use near ''.`netcopya0I5KfqYTfHqJr` FOR UPGRADE'' at line 1 when executing ''CHECK TABLE ... FOR UPGRADE''\nFATAL ERROR: Upgrade failed\nDone building configuration.\nHooks system enabled.\nChecking for and running RPM::Versions ''post'' hooks for any RPMs about to be installed\nAll required ''post'' hooks have been run\nRunning: /usr/local/cpanel/scripts/check_cpanel_pkgs --targets=MySQL41,MySQL50,MySQL51,MySQL55,MySQL56,MariaDB100,MariaDB101 --fix\nRestarting mysql service.\nWaiting for mysql to restart waiting for mysql to initialize finished.\n\u001b[1;32mMariaDB upgrade completed successfully\u001b[0m\n------------------------------------\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">"success"</span></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">"command"</span>: <span class="token string">"background_mysql_upgrade_status"</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/Manage-MySQL-Server/operation/installable_mysql_versions" data-section-id="tag/Manage-MySQL-Server/operation/installable_mysql_versions" class="sc-dntaoT ceciOs"><div data-section-id="operation/installable_mysql_versions" id="operation/installable_mysql_versions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-MySQL-Server/operation/installable_mysql_versions" aria-label="tag/Manage-MySQL-Server/operation/installable_mysql_versions"></a>Return available MySQL versions<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists all available versions of MySQL® and MariaDB.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">MySQL/MariaDB</a> role <strong>and</strong> remote MySQL is <strong>not</strong> already configured, the system disables this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all available versions of MySQL® and MariaDB.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">MySQL/MariaDB</a> role <strong>and</strong> remote MySQL is <strong>not</strong> 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/installable_mysql_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/installable_mysql_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:R99936a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99936a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99936a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99936a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99936a:0" aria-labelledby="tab:R99936a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
installable_mysql_versions
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99936a:1" aria-labelledby="tab:R99936a: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:R9p936a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p936a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p936a:0" aria-labelledby="tab:R9p936a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"server"</span>: <span class="token string">"mariadb"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"10.0"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="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">"installable_mysql_versions"</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/Manage-MySQL-Server/operation/latest_available_mysql_version" data-section-id="tag/Manage-MySQL-Server/operation/latest_available_mysql_version" class="sc-dntaoT ceciOs"><div data-section-id="operation/latest_available_mysql_version" id="operation/latest_available_mysql_version" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-MySQL-Server/operation/latest_available_mysql_version" aria-label="tag/Manage-MySQL-Server/operation/latest_available_mysql_version"></a>Return latest MySQL version<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the latest available version of MySQL® or MariaDB®.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL/MariaDB 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 retrieves the latest available version of MySQL® or MariaDB®.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL/MariaDB 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/latest_available_mysql_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/latest_available_mysql_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:R99b36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b36a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b36a:0" aria-labelledby="tab:R99b36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
latest_available_mysql_version
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b36a:1" aria-labelledby="tab:R99b36a: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:R9pb36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb36a:0" aria-labelledby="tab:R9pb36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"server"</span>: <span class="token string">"mariadb"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"10.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">"metadata"</span>: <button class="collapser" aria-label="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">"latest_available_mysql_version"</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/Manage-MySQL-Server/operation/update_sql_config" data-section-id="tag/Manage-MySQL-Server/operation/update_sql_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/update_sql_config" id="operation/update_sql_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-MySQL-Server/operation/update_sql_config" aria-label="tag/Manage-MySQL-Server/operation/update_sql_config"></a>Update the servers SQL configuration.<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function updates the database configuration file for MySQL® or MariaDB®.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL/MariaDB 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 updates the database configuration file for MySQL® or MariaDB®.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL/MariaDB 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><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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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">objects</span></div> <div><div html="<p>Array of objects that contains the requested updates to the sql configuration.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Array of objects that contains the requested updates to the sql configuration.</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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/update_sql_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/update_sql_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:R99d36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d36a:0" tabindex="0" data-rttab="true">Payload</li><li class="react-tabs__tab" role="tab" id="tab:R99d36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d36a:1" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d36a:2" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d36a:0" aria-labelledby="tab:R99d36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"max_allowed_packet"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"section"</span>: <span class="token string">"mysqld"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"268435456"</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:R99d36a:1" aria-labelledby="tab:R99d36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d36a:2" aria-labelledby="tab:R99d36a: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:R9pd36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd36a:0" aria-labelledby="tab:R9pd36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"update_sql_config"</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/Manage-MySQL-Server/operation/start_background_mysql_upgrade" data-section-id="tag/Manage-MySQL-Server/operation/start_background_mysql_upgrade" class="sc-dntaoT ceciOs"><div data-section-id="operation/start_background_mysql_upgrade" id="operation/start_background_mysql_upgrade" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-MySQL-Server/operation/start_background_mysql_upgrade" aria-label="tag/Manage-MySQL-Server/operation/start_background_mysql_upgrade"></a>Start background MySQL upgrade<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function upgrades MySQL® or MariaDB® in the background. This will reinstall MySQL® or MariaDB® if the version given is the installed version.</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">MySQL/MariaDB server 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 upgrades MySQL® or MariaDB® in the background. This will reinstall MySQL® or MariaDB® if the version given is the installed version.</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">MySQL/MariaDB server 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="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">number</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">version=5.7</span></div><div><div html="<p>The desired MySQL® or MariaDB® version. Must contain one decimal.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The desired MySQL® or MariaDB® version. Must contain one decimal.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/start_background_mysql_upgrade</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/start_background_mysql_upgrade</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f36a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f36a:0" aria-labelledby="tab:R99f36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
start_background_mysql_upgrade <span class="token punctuation">\</span>
<span class="token assign-left variable">version</span><span class="token operator">=</span><span class="token string">'5.7'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f36a:1" aria-labelledby="tab:R99f36a: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:R9pf36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf36a:0" aria-labelledby="tab:R9pf36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"upgrade_id"</span>: <span class="token string">"mysql_upgrade.20200202-172923"</span></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">"command"</span>: <span class="token string">"start_background_mysql_upgrade"</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/Manage-MySQL-Server/operation/set_local_mysql_root_password" data-section-id="tag/Manage-MySQL-Server/operation/set_local_mysql_root_password" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_local_mysql_root_password" id="operation/set_local_mysql_root_password" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-MySQL-Server/operation/set_local_mysql_root_password" aria-label="tag/Manage-MySQL-Server/operation/set_local_mysql_root_password"></a>Update MySQL root password<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function resets the root user&#39;s password on the local MySQL® server.</p>
<p><strong>Important:</strong></p>
<p> When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles"><em>MySQL/MariaDB role</em></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 resets the root user's password on the local MySQL® server.</p>
<p><strong>Important:</strong></p>
<p> When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles"><em>MySQL/MariaDB role</em></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="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 MySQL root user&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new MySQL root user's password.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="update_config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">update_config</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">update_config=1</span></div><div><div html="<p>Whether to update the configuration files.</p>
<ul>
<li><code>1</code> — Update.</li>
<li><code>0</code> — Do <strong>not</strong> update.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This value is always enabled when <em>localhost</em> is the active profile, and must be specified explicitly when a remote profile is active.</p>
<p><strong>Warning:</strong></p>
<p>This parameter updates the <code>/root/.my.cnf</code> file with the new password, which could cause problems with the MySQL configuration on the server. If you are unsure, do <strong>not</strong> specify this parameter.</p>
<ul>
<li>If you set this parameter to <code>0</code> when <em>localhost</em> is the active profile, it will stop communication with the remote MySQL server until you update the profile&#39;s password.</li>
<li>If you set this parameter to <code>1</code> when a remote host is the active profile, it will stop communication with the remote MySQL server until you update the profile&#39;s password.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to update the configuration files.</p>
<ul>
<li><code>1</code> — Update.</li>
<li><code>0</code> — Do <strong>not</strong> update.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This value is always enabled when <em>localhost</em> is the active profile, and must be specified explicitly when a remote profile is active.</p>
<p><strong>Warning:</strong></p>
<p>This parameter updates the <code>/root/.my.cnf</code> file with the new password, which could cause problems with the MySQL configuration on the server. If you are unsure, do <strong>not</strong> specify this parameter.</p>
<ul>
<li>If you set this parameter to <code>0</code> when <em>localhost</em> is the active profile, it will stop communication with the remote MySQL server until you update the profile's password.</li>
<li>If you set this parameter to <code>1</code> when a remote host is the active profile, it will stop communication with the remote MySQL server until you update the profile's password.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/set_local_mysql_root_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_local_mysql_root_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:R99h36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h36a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h36a:0" aria-labelledby="tab:R99h36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_local_mysql_root_password <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:R99h36a:1" aria-labelledby="tab:R99h36a: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:R9ph36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph36a:0" aria-labelledby="tab:R9ph36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"configs_updated"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"password_reset"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"profile_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">"metadata"</span>: <button class="collapser" aria-label="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">"set_local_mysql_root_password"</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/MySQL-Databases" data-section-id="tag/MySQL-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/MySQL-Databases" aria-label="tag/MySQL-Databases"></a>MySQL Databases</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Databases / MySQL Databases</p>
"><p>Databases / MySQL Databases</p>
</div></div></div><div id="tag/MySQL-Databases/operation/list_database_users" data-section-id="tag/MySQL-Databases/operation/list_database_users" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_database_users" id="operation/list_database_users" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/MySQL-Databases/operation/list_database_users" aria-label="tag/MySQL-Databases/operation/list_database_users"></a>Return MySQL users<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the server&#39;s database users.</p>
<p><strong>Warning:</strong></p>
<p>On most servers, this function returns a large amount of output. We <strong>strongly</strong> suggest that you filter and sort the output.</p>
<p><strong>Important:</strong></p>
<p> When you disable the <a href="https://go.cpanel.net/serverroles">MySQL/MariaDB and PostgreSQL roles</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 lists the server's database users.</p>
<p><strong>Warning:</strong></p>
<p>On most servers, this function returns a large amount of output. We <strong>strongly</strong> suggest that you filter and sort the output.</p>
<p><strong>Important:</strong></p>
<p> When you disable the <a href="https://go.cpanel.net/serverroles">MySQL/MariaDB and PostgreSQL roles</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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_database_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_database_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:R4kj56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj56a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj56a:0" aria-labelledby="tab:R4kj56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_database_users
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj56a:1" aria-labelledby="tab:R4kj56a: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:R4sj56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj56a:0" aria-labelledby="tab:R4sj56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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"</span>: <span class="token string">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"engine"</span>: <span class="token string">"postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"example_user1"</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">"metadata"</span>: <button class="collapser" aria-label="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">"list_database_users"</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/MySQL-Databases/operation/list_databases" data-section-id="tag/MySQL-Databases/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/MySQL-Databases/operation/list_databases" aria-label="tag/MySQL-Databases/operation/list_databases"></a>Return MySQL databases<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the server&#39;s databases.</p>
<p><strong>Warning:</strong></p>
<p>On most servers, this function returns a large amount of output. We strongly suggest that you <a href="https://go.cpanel.net/WHMAPI1FilterOutput">filter</a> and <a href="https://go.cpanel.net/WHMAPI1SortOutput">sort</a> the output.</p>
<p><strong>Important:</strong></p>
<p>When you disable the MySQL/MariaDB and PostgreSQL <a href="https://go.cpanel.net/serverroles">roles</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 lists the server's databases.</p>
<p><strong>Warning:</strong></p>
<p>On most servers, this function returns a large amount of output. We strongly suggest that you <a href="https://go.cpanel.net/WHMAPI1FilterOutput">filter</a> and <a href="https://go.cpanel.net/WHMAPI1SortOutput">sort</a> the output.</p>
<p><strong>Important:</strong></p>
<p>When you disable the MySQL/MariaDB and PostgreSQL <a href="https://go.cpanel.net/serverroles">roles</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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R4kl56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl56a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl56a:0" aria-labelledby="tab:R4kl56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_databases
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl56a:1" aria-labelledby="tab:R4kl56a: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:R4sl56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl56a:0" aria-labelledby="tab:R4sl56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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"</span>: <span class="token string">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"engine"</span>: <span class="token string">"postgresql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"example_db0"</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">"metadata"</span>: <button class="collapser" aria-label="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">"list_databases"</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/MySQL-Databases/operation/list_mysql_databases_and_users" data-section-id="tag/MySQL-Databases/operation/list_mysql_databases_and_users" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_mysql_databases_and_users" id="operation/list_mysql_databases_and_users" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/MySQL-Databases/operation/list_mysql_databases_and_users" aria-label="tag/MySQL-Databases/operation/list_mysql_databases_and_users"></a>Return MySQL databases and users for account<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the MySQL® database and user data for the specified account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">MySQL/MariaDB</a> role <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 retrieves the MySQL® database and user data for the specified account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">MySQL/MariaDB</a> role <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="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=username</span></div><div><div html="<p>The username for a specified account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username for a specified 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_mysql_databases_and_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_mysql_databases_and_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:R4kn56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn56a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn56a:0" aria-labelledby="tab:R4kn56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_mysql_databases_and_users <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R4kn56a:1" aria-labelledby="tab:R4kn56a: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:R4sn56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn56a:0" aria-labelledby="tab:R4sn56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"mysql_config"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"mysql-version"</span>: <span class="token string">"5.5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prefix_length"</span>: <span class="token number">8</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"use_db_prefix"</span>: <span class="token number">1</span></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="obj collapsible"><li><div class="hoverable "><span class="property token string">"user1_database1"</span>: <button class="collapser" aria-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_user1"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user2_database2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"user2_user2"</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">"metadata"</span>: <button class="collapser" aria-label="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">"list_mysql_databases_and_users"</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/MySQL-Databases/operation/rename_mysql_user" data-section-id="tag/MySQL-Databases/operation/rename_mysql_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/rename_mysql_user" id="operation/rename_mysql_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/MySQL-Databases/operation/rename_mysql_user" aria-label="tag/MySQL-Databases/operation/rename_mysql_user"></a>Update MySQL username<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function changes a MySQL® database user&#39;s name.</p>
<p><strong>Important:</strong></p>
<p> When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles"><em>MySQL/MariaDB role</em></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 changes a MySQL® database user's name.</p>
<p><strong>Important:</strong></p>
<p> When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles"><em>MySQL/MariaDB role</em></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="cpuser" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpuser</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">cpuser=example</span></div><div><div html="<p>The database user&#39;s owner.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user's owner.</p>
</div></div></div></td></tr><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=username2</span></div><div><div html="<p>The database user&#39;s new name.</p>
<p><strong>Warning:</strong></p>
<p>If database prefix 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>Warning:</strong></p>
<p>If database prefix 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=username</span></div><div><div html="<p>The database user&#39;s current name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database 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="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">/rename_mysql_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/rename_mysql_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:R4kp56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp56a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp56a:0" aria-labelledby="tab:R4kp56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
rename_mysql_user <span class="token punctuation">\</span>
<span class="token assign-left variable">oldname</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">newname</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:R4kp56a:1" aria-labelledby="tab:R4kp56a: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:R4sp56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp56a:0" aria-labelledby="tab:R4sp56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"rename_mysql_user"</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/MySQL-Databases/operation/rename_mysql_database" data-section-id="tag/MySQL-Databases/operation/rename_mysql_database" class="sc-dntaoT ceciOs"><div data-section-id="operation/rename_mysql_database" id="operation/rename_mysql_database" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/MySQL-Databases/operation/rename_mysql_database" aria-label="tag/MySQL-Databases/operation/rename_mysql_database"></a>Update MySQL database name<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function changes a MySQL® database&#39;s name. MySQL does <strong>not</strong> 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>If <strong>any</strong> 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/howtouseserverprofiles#roles"><em>MySQL/MariaDB role</em></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 changes a MySQL® database's name. MySQL does <strong>not</strong> 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>If <strong>any</strong> 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/howtouseserverprofiles#roles"><em>MySQL/MariaDB role</em></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="cpuser" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpuser</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">cpuser=username</span></div><div><div html="<p>The database&#39;s owner.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database's owner.</p>
</div></div></div></td></tr><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=database2</span></div><div><div html="<p>The database&#39;s new name.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>If database prefixing is enabled, this parameter <strong>must</strong> include the database prefix for the account.</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 <strong>two</strong> characters of that limit. Therefore, if you enable database prefixing, the maximum length of the database name is <strong>63 characters</strong>, which includes both the database prefix and the underscore character. Each additional underscore <strong>requires</strong> another <strong>two</strong> characters of that limit.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database's new name.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>If database prefixing is enabled, this parameter <strong>must</strong> include the database prefix for the account.</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 <strong>two</strong> characters of that limit. Therefore, if you enable database prefixing, the maximum length of the database name is <strong>63 characters</strong>, which includes both the database prefix and the underscore character. Each additional underscore <strong>requires</strong> another <strong>two</strong> 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=database</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="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">/rename_mysql_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/rename_mysql_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:R4kr56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr56a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr56a:0" aria-labelledby="tab:R4kr56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
rename_mysql_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:R4kr56a:1" aria-labelledby="tab:R4kr56a: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:R4sr56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr56a:0" aria-labelledby="tab:R4sr56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"rename_mysql_database"</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/MySQL-Databases/operation/set_mysql_password" data-section-id="tag/MySQL-Databases/operation/set_mysql_password" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_mysql_password" id="operation/set_mysql_password" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/MySQL-Databases/operation/set_mysql_password" aria-label="tag/MySQL-Databases/operation/set_mysql_password"></a>Update MySQL user password<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function changes a MySQL® database user&#39;s password.</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 changes a MySQL® database user's password.</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="cpuser" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpuser</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">cpuser=example</span></div><div><div html="<p>The cPanel user that controls the database user.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel user that controls the database user.</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 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><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=username</span></div><div><div html="<p>The database username. For information about database username
restrictions, read the
<a href="https://dev.mysql.com/">MySQL</a> and <a href="https://mariadb.org/">MariaDB</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database username. For information about database username
restrictions, read the
<a href="https://dev.mysql.com/">MySQL</a> and <a href="https://mariadb.org/">MariaDB</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="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">/set_mysql_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_mysql_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:R4kt56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kt56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kt56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt56a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kt56a:0" aria-labelledby="tab:R4kt56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_mysql_password <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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">'123456luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt56a:1" aria-labelledby="tab:R4kt56a: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:R4st56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4st56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4st56a:0" aria-labelledby="tab:R4st56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_mysql_password"</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/MySQL-Databases/operation/get_database_optimizations" data-section-id="tag/MySQL-Databases/operation/get_database_optimizations" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_database_optimizations" id="operation/get_database_optimizations" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/MySQL-Databases/operation/get_database_optimizations" aria-label="tag/MySQL-Databases/operation/get_database_optimizations"></a>Return MySQL database optimizations<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves available database optimizations.</p>
<p><strong>Warning:</strong></p>
<p>On some servers, this function may return a large amount of output. We strongly suggest that you <a href="https://go.cpanel.net/WHMAPI1FilterOutput">filter</a> and <a href="https://go.cpanel.net/WHMAPI1SortOutput">sort</a> the output.</p>
<p><strong>Important:</strong></p>
<p>The system <strong>disables</strong> this function when you have <strong>not</strong> configured remote MySQL, and you&#39;ve disabled the MySQL/MariaDB and PostgreSQL <a href="https://go.cpanel.net/serverroles">roles</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves available database optimizations.</p>
<p><strong>Warning:</strong></p>
<p>On some servers, this function may return a large amount of output. We strongly suggest that you <a href="https://go.cpanel.net/WHMAPI1FilterOutput">filter</a> and <a href="https://go.cpanel.net/WHMAPI1SortOutput">sort</a> the output.</p>
<p><strong>Important:</strong></p>
<p>The system <strong>disables</strong> this function when you have <strong>not</strong> configured remote MySQL, and you've disabled the MySQL/MariaDB and PostgreSQL <a href="https://go.cpanel.net/serverroles">roles</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_database_optimizations</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_database_optimizations</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kv56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kv56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kv56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kv56a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kv56a:0" aria-labelledby="tab:R4kv56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_database_optimizations
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kv56a:1" aria-labelledby="tab:R4kv56a: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:R4sv56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sv56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sv56a:0" aria-labelledby="tab:R4sv56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"innodb_sort_buffer_size"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Your system's peak theoretical memory allocation is too high and may cause instability."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"2M"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_database_optimizations"</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/PostgreSQL-Databases" data-section-id="tag/PostgreSQL-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/PostgreSQL-Databases" aria-label="tag/PostgreSQL-Databases"></a>PostgreSQL Databases</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Databases / PostgreSQL Databases</p>
"><p>Databases / PostgreSQL Databases</p>
</div></div></div><div id="tag/PostgreSQL-Databases/operation/rename_postgresql_database" data-section-id="tag/PostgreSQL-Databases/operation/rename_postgresql_database" class="sc-dntaoT ceciOs"><div data-section-id="operation/rename_postgresql_database" id="operation/rename_postgresql_database" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-Databases/operation/rename_postgresql_database" aria-label="tag/PostgreSQL-Databases/operation/rename_postgresql_database"></a>Update PostgreSQL database name<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function changes a PostgreSQL® database&#39;s name.</p>
<p><strong>Warning:</strong></p>
<p> The system requires more time to rename larger and more complex databases.</p>
<p><strong>Important:</strong></p>
<p> When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles"><em>PostgreSQL role</em></a>, the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes a PostgreSQL® database's name.</p>
<p><strong>Warning:</strong></p>
<p> The system requires more time to rename larger and more complex databases.</p>
<p><strong>Important:</strong></p>
<p> When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles"><em>PostgreSQL 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="cpuser" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpuser</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">cpuser=username</span></div><div><div html="<p>The database&#39;s owner.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database's owner.</p>
</div></div></div></td></tr><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>Warning:</strong>
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>Warning:</strong>
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>
" 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="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">/rename_postgresql_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/rename_postgresql_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:R2ab76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab76a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab76a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab76a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab76a:0" aria-labelledby="tab:R2ab76a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
rename_postgresql_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:R2ab76a:1" aria-labelledby="tab:R2ab76a: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:R2eb76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb76a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb76a:0" aria-labelledby="tab:R2eb76a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"rename_postgresql_database"</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/PostgreSQL-Databases/operation/set_postgresql_password" data-section-id="tag/PostgreSQL-Databases/operation/set_postgresql_password" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_postgresql_password" id="operation/set_postgresql_password" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-Databases/operation/set_postgresql_password" aria-label="tag/PostgreSQL-Databases/operation/set_postgresql_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/howtouseserverprofiles#roles">PostgreSQL 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/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=""><td kind="field" title="cpuser" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpuser</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cpuser=example</span></div><div><div html="<p>The database user&#39;s owner.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user's owner.</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 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><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 account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 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="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">/set_postgresql_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_postgresql_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:R2ad76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad76a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad76a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad76a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad76a:0" aria-labelledby="tab:R2ad76a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_postgresql_password <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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">'12345luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad76a:1" aria-labelledby="tab:R2ad76a: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:R2ed76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed76a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed76a:0" aria-labelledby="tab:R2ed76a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_postgresql_password"</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/PostgreSQL-Databases/operation/rename_postgresql_user" data-section-id="tag/PostgreSQL-Databases/operation/rename_postgresql_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/rename_postgresql_user" id="operation/rename_postgresql_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-Databases/operation/rename_postgresql_user" aria-label="tag/PostgreSQL-Databases/operation/rename_postgresql_user"></a>Update PostgreSQL username<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function changes a PostgreSQL® database user&#39;s name.</p>
<p><strong>Important:</strong></p>
<p> When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles"><em>PostgreSQL role</em></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 name.</p>
<p><strong>Important:</strong></p>
<p> When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles"><em>PostgreSQL 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="cpuser" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpuser</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cpuser=example</span></div><div><div html="<p>The database user&#39;s owner.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user's owner.</p>
</div></div></div></td></tr><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=username2</span></div><div><div html="<p>The database user&#39;s new name.</p>
<p><strong>Warning:</strong>
If database prefix 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>Warning:</strong>
If database prefix 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><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">oldname=username</span></div><div><div html="<p>The database user&#39;s current name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user's current name.</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 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="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">/rename_postgresql_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/rename_postgresql_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:R2af76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2af76a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2af76a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af76a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2af76a:0" aria-labelledby="tab:R2af76a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
rename_postgresql_user <span class="token punctuation">\</span>
<span class="token assign-left variable">oldname</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">newname</span><span class="token operator">=</span><span class="token string">'username2'</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:R2af76a:1" aria-labelledby="tab:R2af76a: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:R2ef76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ef76a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ef76a:0" aria-labelledby="tab:R2ef76a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"rename_postgresql_user"</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/Remote-MySQL-Databases" data-section-id="tag/Remote-MySQL-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-MySQL-Databases" aria-label="tag/Remote-MySQL-Databases"></a>Remote MySQL Databases</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Databases / Remote MySQL Databases</p>
"><p>Databases / Remote MySQL Databases</p>
</div></div></div><div id="tag/Remote-MySQL-Databases/operation/remote_mysql_delete_profile" data-section-id="tag/Remote-MySQL-Databases/operation/remote_mysql_delete_profile" class="sc-dntaoT ceciOs"><div data-section-id="operation/remote_mysql_delete_profile" id="operation/remote_mysql_delete_profile" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Remote-MySQL-Databases/operation/remote_mysql_delete_profile" aria-label="tag/Remote-MySQL-Databases/operation/remote_mysql_delete_profile"></a>Delete remote MySQL profile<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deletes a specified remote MySQL® profile.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a specified remote MySQL® profile.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=MyProfile</span></div><div><div html="<p>The profile&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The profile'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/remote_mysql_delete_profile</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remote_mysql_delete_profile</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99396a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99396a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99396a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99396a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99396a:0" aria-labelledby="tab:R99396a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remote_mysql_delete_profile <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'MyProfile'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99396a:1" aria-labelledby="tab:R99396a: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:R9p396a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p396a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p396a:0" aria-labelledby="tab:R9p396a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"profile_deleted"</span>: <span class="token string">"MyProfile"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"profile_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">"active"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_host"</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">"mysql_pass"</span>: <span class="token string">"12345luggage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_port"</span>: <span class="token number">3306</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_user"</span>: <span class="token string">"username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setup_via"</span>: <span class="token string">"Main terminal"</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"remote_mysql_delete_profile"</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/Remote-MySQL-Databases/operation/remote_mysql_initiate_profile_activation" data-section-id="tag/Remote-MySQL-Databases/operation/remote_mysql_initiate_profile_activation" class="sc-dntaoT ceciOs"><div data-section-id="operation/remote_mysql_initiate_profile_activation" id="operation/remote_mysql_initiate_profile_activation" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Remote-MySQL-Databases/operation/remote_mysql_initiate_profile_activation" aria-label="tag/Remote-MySQL-Databases/operation/remote_mysql_initiate_profile_activation"></a>Start remote MySQL profile activation<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function initiates the activation process for a remote MySQL® profile.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function initiates the activation process for a remote MySQL® profile.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=MyProfile</span></div><div><div html="<p>The profile&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The profile'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/remote_mysql_initiate_profile_activation</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remote_mysql_initiate_profile_activation</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99596a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99596a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99596a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99596a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99596a:0" aria-labelledby="tab:R99596a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remote_mysql_initiate_profile_activation <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'MyProfile'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99596a:1" aria-labelledby="tab:R99596a: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:R9p596a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p596a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p596a:0" aria-labelledby="tab:R9p596a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"activation_job_started"</span>: <span class="token number">8093</span></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">"command"</span>: <span class="token string">"remote_mysql_initiate_profile_activation"</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/Remote-MySQL-Databases/operation/remote_mysql_read_profile" data-section-id="tag/Remote-MySQL-Databases/operation/remote_mysql_read_profile" class="sc-dntaoT ceciOs"><div data-section-id="operation/remote_mysql_read_profile" id="operation/remote_mysql_read_profile" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Remote-MySQL-Databases/operation/remote_mysql_read_profile" aria-label="tag/Remote-MySQL-Databases/operation/remote_mysql_read_profile"></a>Return remote MySQL profile<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function displays the details of a specified remote MySQL® profile.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function displays the details of a specified remote MySQL® profile.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=MyProfile</span></div><div><div html="<p>The MySQL profile&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL profile'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/remote_mysql_read_profile</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remote_mysql_read_profile</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99796a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99796a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99796a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99796a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99796a:0" aria-labelledby="tab:R99796a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remote_mysql_read_profile <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'MyProfile'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99796a:1" aria-labelledby="tab:R99796a: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:R9p796a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p796a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p796a:0" aria-labelledby="tab:R9p796a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"profile_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">"active"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_host"</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">"mysql_pass"</span>: <span class="token string">"123456luggage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_port"</span>: <span class="token number">3306</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_user"</span>: <span class="token string">"username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setup_via"</span>: <span class="token string">"Main terminal"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"profile_name"</span>: <span class="token string">"MyProfile"</span></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">"command"</span>: <span class="token string">"remote_mysql_read_profile"</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/Remote-MySQL-Databases/operation/remote_mysql_monitor_profile_activation" data-section-id="tag/Remote-MySQL-Databases/operation/remote_mysql_monitor_profile_activation" class="sc-dntaoT ceciOs"><div data-section-id="operation/remote_mysql_monitor_profile_activation" id="operation/remote_mysql_monitor_profile_activation" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Remote-MySQL-Databases/operation/remote_mysql_monitor_profile_activation" aria-label="tag/Remote-MySQL-Databases/operation/remote_mysql_monitor_profile_activation"></a>Return remote MySQL profile activation<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function reports the current status of the remote MySQL® profile activation process. The activation process contains several steps that take some time to complete, so so you may need to call this function multiple times multiple times to monitor the progress.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function reports the current status of the remote MySQL® profile activation process. The activation process contains several steps that take some time to complete, so so you may need to call this function multiple times multiple times to monitor the progress.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/remote_mysql_monitor_profile_activation</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remote_mysql_monitor_profile_activation</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99996a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99996a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99996a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99996a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99996a:0" aria-labelledby="tab:R99996a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remote_mysql_monitor_profile_activation
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99996a:1" aria-labelledby="tab:R99996a: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:R9p996a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p996a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p996a:0" aria-labelledby="tab:R9p996a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"job_in_progress"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"profile_name"</span>: <span class="token string">"remote_server"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1432064519</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"INPROGRESS"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"steps"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"end_time"</span>: <span class="token number">1432064520</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Updating /root/.my.cnf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1432064519</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></div></li></ul><span class="token punctuation">]</span></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_job_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">"end_time"</span>: <span class="token number">1432220941</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"profile_name"</span>: <span class="token string">"MyProfile"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1432064519</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"steps"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"end_time"</span>: <span class="token number">1432220941</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token number">1432220941</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></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">"metadata"</span>: <button class="collapser" aria-label="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">"remote_mysql_monitor_profile_activation"</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/Remote-MySQL-Databases/operation/remote_mysql_update_profile" data-section-id="tag/Remote-MySQL-Databases/operation/remote_mysql_update_profile" class="sc-dntaoT ceciOs"><div data-section-id="operation/remote_mysql_update_profile" id="operation/remote_mysql_update_profile" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Remote-MySQL-Databases/operation/remote_mysql_update_profile" aria-label="tag/Remote-MySQL-Databases/operation/remote_mysql_update_profile"></a>Update remote MySQL profile<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function updates one or more parameters for a remote MySQL®
profile.</p>
<p><strong>Note:</strong>
This function requires the <code>name</code> parameter <strong>and</strong> one of more of the <code>mysql_host</code> , <code>mysql_user</code>, <code>mysql_pass</code>, <code>mysql_port</code>, or <code>setup_via</code> parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates one or more parameters for a remote MySQL®
profile.</p>
<p><strong>Note:</strong>
This function requires the <code>name</code> parameter <strong>and</strong> one of more of the <code>mysql_host</code> , <code>mysql_user</code>, <code>mysql_pass</code>, <code>mysql_port</code>, or <code>setup_via</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="mysql_host" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand mysql_host"><span class="property-name">mysql_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></td><td 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">mysql_host=192.168.0.1</span></div><div><div html="<p>The MySQL server&#39;s IP address or hostname.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL server's IP address or hostname.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="mysql_pass" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mysql_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">mysql_pass=12345luggage</span></div><div><div html="<p>The MySQL server&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL server's password.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="mysql_port" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mysql_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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mysql_port=3306</span></div><div><div html="<p>The MySQL server&#39;s port.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL server's port.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="mysql_user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mysql_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">mysql_user=username</span></div><div><div html="<p>The MySQL server&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL server's username.</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=MyProfile</span></div><div><div html="<p>The profile&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The profile's name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="setup_via" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">setup_via</span></td><td class="sc-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"> <!-- --><= 255 characters<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">setup_via=Main terminal</span></div><div><div html="<p>A description of the profile data.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A description of the profile 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/remote_mysql_update_profile</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remote_mysql_update_profile</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b96a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b96a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b96a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b96a:0" aria-labelledby="tab:R99b96a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remote_mysql_update_profile <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'MyProfile'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b96a:1" aria-labelledby="tab:R99b96a: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:R9pb96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb96a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb96a:0" aria-labelledby="tab:R9pb96a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"profile_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">"active"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_host"</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">"mysql_pass"</span>: <span class="token string">"12345luggage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_port"</span>: <span class="token number">3306</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_user"</span>: <span class="token string">"username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setup_via"</span>: <span class="token string">"Main terminal"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"profile_saved"</span>: <span class="token string">"MyProfile"</span></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">"command"</span>: <span class="token string">"remote_mysql_update_profile"</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/Remote-MySQL-Databases/operation/remote_mysql_validate_profile" data-section-id="tag/Remote-MySQL-Databases/operation/remote_mysql_validate_profile" class="sc-dntaoT ceciOs"><div data-section-id="operation/remote_mysql_validate_profile" id="operation/remote_mysql_validate_profile" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Remote-MySQL-Databases/operation/remote_mysql_validate_profile" aria-label="tag/Remote-MySQL-Databases/operation/remote_mysql_validate_profile"></a>Validate remote MySQL profile connection<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function validates a specified remote MySQL® profile&#39;s connection details.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function validates a specified remote MySQL® profile's connection details.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=MyProfile</span></div><div><div html="<p>The profile&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The profile'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/remote_mysql_validate_profile</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remote_mysql_validate_profile</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d96a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d96a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d96a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d96a:0" aria-labelledby="tab:R99d96a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remote_mysql_validate_profile <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'MyProfile'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d96a:1" aria-labelledby="tab:R99d96a: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:R9pd96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd96a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd96a:0" aria-labelledby="tab:R9pd96a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"profile_validated"</span>: <span class="token string">"MyProfile"</span></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">"command"</span>: <span class="token string">"remote_mysql_validate_profile"</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/Remote-MySQL-Databases/operation/remote_mysql_read_profiles" data-section-id="tag/Remote-MySQL-Databases/operation/remote_mysql_read_profiles" class="sc-dntaoT ceciOs"><div data-section-id="operation/remote_mysql_read_profiles" id="operation/remote_mysql_read_profiles" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Remote-MySQL-Databases/operation/remote_mysql_read_profiles" aria-label="tag/Remote-MySQL-Databases/operation/remote_mysql_read_profiles"></a>Return remote MySQL profiles<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function displays the details of all remote MySQL® profiles available in WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function displays the details of all remote MySQL® profiles available in WHM.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/remote_mysql_read_profiles</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remote_mysql_read_profiles</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f96a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f96a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f96a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f96a:0" aria-labelledby="tab:R99f96a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remote_mysql_read_profiles
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f96a:1" aria-labelledby="tab:R99f96a: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:R9pf96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf96a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf96a:0" aria-labelledby="tab:R9pf96a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"MyProfile"</span>: <button class="collapser" aria-label="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">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_localhost_profile"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_host"</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">"mysql_pass"</span>: <span class="token string">"123456luggage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_port"</span>: <span class="token number">3306</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_user"</span>: <span class="token string">"username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_version_is_supported"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setup_via"</span>: <span class="token string">"Main terminal"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MyProfile2"</span>: <button class="collapser" aria-label="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">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_localhost_profile"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_host"</span>: <span class="token string">"192.168.0.2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_pass"</span>: <span class="token string">"123456luggage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_port"</span>: <span class="token number">3306</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_user"</span>: <span class="token string">"username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_version_is_supported"</span>: <span class="token string">"0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setup_via"</span>: <span class="token string">"Main terminal"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"localhost"</span>: <button class="collapser" aria-label="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">"is_localhost_profile"</span>: <span class="token number">1</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_pass"</span>: <span class="token string">"#1mpll-C"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_port"</span>: <span class="token number">3306</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_user"</span>: <span class="token string">"root"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_version_is_supported"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setup_via"</span>: <span class="token string">"Auto-Migrated active profile"</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"remote_mysql_read_profiles"</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/Remote-MySQL-Databases/operation/remote_mysql_create_profile_via_ssh" data-section-id="tag/Remote-MySQL-Databases/operation/remote_mysql_create_profile_via_ssh" class="sc-dntaoT ceciOs"><div data-section-id="operation/remote_mysql_create_profile_via_ssh" id="operation/remote_mysql_create_profile_via_ssh" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Remote-MySQL-Databases/operation/remote_mysql_create_profile_via_ssh" aria-label="tag/Remote-MySQL-Databases/operation/remote_mysql_create_profile_via_ssh"></a>Create remote MySQL profile via SSH<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function uses SSH to create a profile to access a remote MySQL® server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function uses SSH to create a profile to access a remote MySQL® 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="cpcloud" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpcloud</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">cpcloud=1</span></div><div><div html="<p>Whether the remote database profile is a cPanel Cloud deployment.</p>
<ul>
<li><code>1</code> — Is cPanel Cloud.</li>
<li><code>0</code> — <strong>Not</strong> cPanel Cloud.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the remote database profile is a cPanel Cloud deployment.</p>
<ul>
<li><code>1</code> — Is cPanel Cloud.</li>
<li><code>0</code> — <strong>Not</strong> cPanel Cloud.</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=192.168.0.1</span></div><div><div html="<p>The MySQL server&#39;s IP address or hostname.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL server's IP address or hostname.</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=MyProfileSSH</span></div><div><div html="<p>The new profile&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new profile's 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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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 SSH username&#39;s password.</p>
<p><strong>Warning:</strong></p>
<p> You <strong>must</strong> specify either the <code>password</code> or the <code>sshkey_name</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH username's password.</p>
<p><strong>Warning:</strong></p>
<p> You <strong>must</strong> specify either the <code>password</code> or the <code>sshkey_name</code> parameter.</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><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">port=22</span></div><div><div html="<p>The SSH server&#39;s port.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH server's port.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="root_escalation_method" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">root_escalation_method</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"sudo"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"su"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">root_escalation_method=su</span></div><div><div html="<p>The escalation method to use to authenticate the account.</p>
<p><strong>Warning:</strong></p>
<p> This parameter is <strong>required</strong> if the user parameter&#39;s value is not <code>root</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The escalation method to use to authenticate the account.</p>
<p><strong>Warning:</strong></p>
<p> This parameter is <strong>required</strong> if the user parameter's value is not <code>root</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="root_password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">root_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">root_password=username</span></div><div><div html="<p>The MySQL server&#39;s root user&#39;s password.</p>
<p><strong>Warning:</strong></p>
<p> This parameter is <strong>required</strong> if the <code>root_escalation_method</code> parameter&#39;s value is <code>su</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL server's root user's password.</p>
<p><strong>Warning:</strong></p>
<p> This parameter is <strong>required</strong> if the <code>root_escalation_method</code> parameter's value is <code>su</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="sshkey_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">sshkey_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">sshkey_name=VinzClortho</span></div><div><div html="<p>The name of the SSH key.</p>
<p><strong>Warning:</strong></p>
<p> You <strong>must</strong> specify either the <code>password</code> or the <code>sshkey_name</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the SSH key.</p>
<p><strong>Warning:</strong></p>
<p> You <strong>must</strong> specify either the <code>password</code> or the <code>sshkey_name</code> parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="sshkey_passphrase" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">sshkey_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">sshkey_passphrase=Gozer</span></div><div><div html="<p>The SSH key&#39;s passphrase.</p>
<p><strong>Warning:</strong></p>
<p> This parameter is <strong>required</strong> if the <code>sshkey_name</code> value is password-protected.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH key's passphrase.</p>
<p><strong>Warning:</strong></p>
<p> This parameter is <strong>required</strong> if the <code>sshkey_name</code> value is password-protected.</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=SSHuser</span></div><div><div html="<p>The SSH username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/remote_mysql_create_profile_via_ssh</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remote_mysql_create_profile_via_ssh</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99h96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h96a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h96a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h96a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h96a:0" aria-labelledby="tab:R99h96a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remote_mysql_create_profile_via_ssh <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'MyProfileSSH'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'SSHuser'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'192.168.0.1'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">port</span><span class="token operator">=</span><span class="token string">'22'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h96a:1" aria-labelledby="tab:R99h96a: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:R9ph96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph96a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph96a:0" aria-labelledby="tab:R9ph96a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"profile_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">"cpcloud"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_host"</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">"mysql_pass"</span>: <span class="token string">"12345luggage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_port"</span>: <span class="token number">3306</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_user"</span>: <span class="token string">"username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setup_via"</span>: <span class="token string">"Created via SSH"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"profile_saved"</span>: <span class="token string">"MyProfileSSH"</span></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">"command"</span>: <span class="token string">"remote_mysql_create_profile_via_ssh"</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/Remote-MySQL-Databases/operation/remote_mysql_create_profile" data-section-id="tag/Remote-MySQL-Databases/operation/remote_mysql_create_profile" class="sc-dntaoT ceciOs"><div data-section-id="operation/remote_mysql_create_profile" id="operation/remote_mysql_create_profile" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Remote-MySQL-Databases/operation/remote_mysql_create_profile" aria-label="tag/Remote-MySQL-Databases/operation/remote_mysql_create_profile"></a>Create remote MySQL profile<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates a profile to access a remote MySQL® server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a profile to access a remote MySQL® 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="cpcloud" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpcloud</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">cpcloud=1</span></div><div><div html="<p>Whether the remote database profile is a cPanel Cloud deployment.</p>
<ul>
<li><code>1</code> — Is cPanel Cloud.</li>
<li><code>0</code> — <strong>Not</strong> cPanel Cloud.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the remote database profile is a cPanel Cloud deployment.</p>
<ul>
<li><code>1</code> — Is cPanel Cloud.</li>
<li><code>0</code> — <strong>Not</strong> cPanel Cloud.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="mysql_host" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand mysql_host"><span class="property-name">mysql_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">mysql_host=192.168.0.1</span></div><div><div html="<p>The MySQL server&#39;s IP address or hostname.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL server's IP address or hostname.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="mysql_pass" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mysql_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">mysql_pass=12345luggage</span></div><div><div html="<p>The MySQL server&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL server's password.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="mysql_port" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mysql_port</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mysql_port=3306</span></div><div><div html="<p>The MySQL server&#39;s port.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL server's port.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="mysql_user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mysql_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">mysql_user=username</span></div><div><div html="<p>The MySQL server&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL server's username.</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=MyProfile</span></div><div><div html="<p>The new profile&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new profile's name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="setup_via" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">setup_via</span></td><td class="sc-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"> <!-- --><= 255 characters<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">setup_via=Main terminal</span></div><div><div html="<p>A description of the profile data.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to <code>User provided MySQL credentials</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A description of the profile data.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to <code>User provided MySQL credentials</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/remote_mysql_create_profile</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remote_mysql_create_profile</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99j96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j96a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j96a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j96a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j96a:0" aria-labelledby="tab:R99j96a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remote_mysql_create_profile <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'MyProfile'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">mysql_host</span><span class="token operator">=</span><span class="token string">'192.168.0.1'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">mysql_user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">mysql_pass</span><span class="token operator">=</span><span class="token string">'12345luggage'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">mysql_port</span><span class="token operator">=</span><span class="token string">'3306'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j96a:1" aria-labelledby="tab:R99j96a: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:R9pj96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj96a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj96a:0" aria-labelledby="tab:R9pj96a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"profile_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">"active"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpcloud"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_host"</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">"mysql_pass"</span>: <span class="token string">"12345luggage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_port"</span>: <span class="token number">3306</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_user"</span>: <span class="token string">"username"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setup_via"</span>: <span class="token string">"Main terminal"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"profile_saved"</span>: <span class="token string">"MyProfile"</span></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">"command"</span>: <span class="token string">"remote_mysql_create_profile"</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/DNS-Cluster-Settings" data-section-id="tag/DNS-Cluster-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/DNS-Cluster-Settings" aria-label="tag/DNS-Cluster-Settings"></a>DNS Cluster Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>DNS / DNS Cluster Settings</p>
"><p>DNS / DNS Cluster Settings</p>
</div></div></div><div id="tag/DNS-Cluster-Settings/operation/set_nameserver" data-section-id="tag/DNS-Cluster-Settings/operation/set_nameserver" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_nameserver" id="operation/set_nameserver" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Cluster-Settings/operation/set_nameserver" aria-label="tag/DNS-Cluster-Settings/operation/set_nameserver"></a>Update remote DNS server's nameserver software<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the nameserver software that the remote servers in a DNS cluster run. The system queues the nameserver software that you select until the HTTP request finishes. Then, it sets the remote servers&#39; nameserver software.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the nameserver software that the remote servers in a DNS cluster run. The system queues the nameserver software that you select until the HTTP request finishes. Then, it sets the remote servers' nameserver software.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="nameserver" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nameserver</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"BIND"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"PowerDNS"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Disabled"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">nameserver=BIND</span></div><div><div html="<p>The nameserver software.</p>
<ul>
<li><code>BIND</code></li>
<li><code>PowerDNS</code></li>
<li><code>Disabled</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The nameserver software.</p>
<ul>
<li><code>BIND</code></li>
<li><code>PowerDNS</code></li>
<li><code>Disabled</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/set_nameserver</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_nameserver</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R15736q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R15736q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R15736q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R15736q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R15736q:0" aria-labelledby="tab:R15736q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_nameserver <span class="token punctuation">\</span>
<span class="token assign-left variable">nameserver</span><span class="token operator">=</span><span class="token string">'BIND'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R15736q:1" aria-labelledby="tab:R15736q: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:R17736q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R17736q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R17736q:0" aria-labelledby="tab:R17736q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"Queued task to set nameserver to bind successfully."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameserver"</span>: <span class="token string">"bind"</span></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">"command"</span>: <span class="token string">"set_nameserver"</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/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/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 domain's DNSSEC key<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function activates a domain&#39;s DNSSEC security key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function activates a domain's DNSSEC security 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="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 which to activate a security key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to activate a security key.</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>
<p><strong>Note:</strong></p>
<p>Use the WHM AP1 <code>fetch_ds_records_for_domains</code> function to locate the domain&#39;s security key ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key's ID.</p>
<p><strong>Note:</strong></p>
<p>Use the WHM AP1 <code>fetch_ds_records_for_domains</code> function to locate the domain's security key 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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99356q:1" aria-labelledby="tab:R99356q: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: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">"metadata"</span>: <button class="collapser" aria-label="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">"activate_zone_key"</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/DNS-Security/operation/disable_dnssec_for_domains" data-section-id="tag/DNS-Security/operation/disable_dnssec_for_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_dnssec_for_domains" id="operation/disable_dnssec_for_domains" 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_for_domains" aria-label="tag/DNS-Security/operation/disable_dnssec_for_domains"></a>Disable DNSSEC on domain<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function disables DNSSEC on the domain.</p>
<p><strong>Note:</strong></p>
<p> Only servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn&#39;t use PowerDNS, you will receive an error.</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 keys by restoring them from a full back up of the account.</li>
<li>If you disable DNSSEC, you <strong>must</strong> remove the Delegation of Signing (DS) records on your DNS server and with your registrar.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables DNSSEC on the domain.</p>
<p><strong>Note:</strong></p>
<p> Only servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn't use PowerDNS, you will receive an error.</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 keys by restoring them from a full back up of the account.</li>
<li>If you disable DNSSEC, you <strong>must</strong> remove the Delegation of Signing (DS) records on your DNS server and with your registrar.</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-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 for which to disable DNSSEC.</p>
<p><strong>Note:</strong></p>
<p>To disable DNSSEC for multiple domains, duplicate or increment the parameter name. For example, to check 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>, <code>domain-2</code> parameters.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to disable DNSSEC.</p>
<p><strong>Note:</strong></p>
<p>To disable DNSSEC for multiple domains, duplicate or increment the parameter name. For example, to check 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>, <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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/disable_dnssec_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/disable_dnssec_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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
disable_dnssec_for_domains <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:R99556q:1" aria-labelledby="tab:R99556q: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: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">"data"</span>: <button class="collapser" aria-label="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 "><button class="collapser" aria-label="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>: <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></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">"metadata"</span>: <button class="collapser" aria-label="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">"disable_dnssec_for_domains"</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/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 domain's DNSSEC key<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deactivates a domain&#39;s DNSSEC security key.</p>
<p><strong>Note:</strong></p>
<p>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server
that doesn&#39;t use PowerDNS, you will receive an error.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deactivates a domain's DNSSEC security key.</p>
<p><strong>Note:</strong></p>
<p>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server
that doesn't use PowerDNS, you will receive an error.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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 which to deactivate a security key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to deactivate a security key.</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></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>
<p><strong>Note:</strong></p>
<p>Use the WHM AP1 <code>fetch_ds_records_for_domains</code> function to locate the
domain&#39;s security key ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key's ID.</p>
<p><strong>Note:</strong></p>
<p>Use the WHM AP1 <code>fetch_ds_records_for_domains</code> function to locate the
domain's security key 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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99756q:1" aria-labelledby="tab:R99756q: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: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">"metadata"</span>: <button class="collapser" aria-label="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">"deactivate_zone_key"</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/DNS-Security/operation/enable_dnssec_for_domains" data-section-id="tag/DNS-Security/operation/enable_dnssec_for_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_dnssec_for_domains" id="operation/enable_dnssec_for_domains" 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_for_domains" aria-label="tag/DNS-Security/operation/enable_dnssec_for_domains"></a>Enable DNSSEC on domain<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables DNSSEC on the domain.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn&#39;t use PowerDNS, you will receive an error.</li>
<li>After you enable DNSSEC on the domain, you <strong>must</strong> add the Delegation of Signing (DS) records on your DNS server and with your registrar.</li>
<li>You <strong>cannot</strong> modify the DNSSEC security key. To make any changes, you <strong>must</strong> disable, delete, and re-create the DNSSEC security key.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables DNSSEC on the domain.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn't use PowerDNS, you will receive an error.</li>
<li>After you enable DNSSEC on the domain, you <strong>must</strong> add the Delegation of Signing (DS) records on your DNS server and with your registrar.</li>
<li>You <strong>cannot</strong> modify the DNSSEC security key. To make any changes, you <strong>must</strong> disable, delete, and re-create the DNSSEC security key.</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="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></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"> <!-- -->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 an ECDSA Curve P-256 with SHA-256 (13) value 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 an ECDSA Curve P-256 with SHA-256 (13) value 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=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 for which to enable DNSSEC.</p>
<p><strong>Note:</strong></p>
<p>To enable DNSSEC on multiple domains, duplicate or increment the parameter name. For example, to check 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 DNSSEC.</p>
<p><strong>Note:</strong></p>
<p>To enable DNSSEC on multiple domains, duplicate or increment the parameter name. For example, to check 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><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">"classic"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"simple"</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>classic</code> - Use separate keys for KSK and ZSK. Use this value when the <code>algo_num</code> parameter is equal to or less than 8.</li>
<li><code>simple</code> - Use a single key for both KSK and ZSK. Use this value when the <code>algo_num</code> parameter is greater than 8.</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>classic</code> - Use separate keys for KSK and ZSK. Use this value when the <code>algo_num</code> parameter is equal to or less than 8.</li>
<li><code>simple</code> - Use a single key for both KSK and ZSK. Use this value when the <code>algo_num</code> parameter is greater than 8.</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>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of times that the system rehashes 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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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 operates in Narrow or Inclusive mode.</p>
<p><strong>Note:</strong></p>
<p>For information about these modes, read <a href="https://doc.powerdns.com/authoritative/dnssec/intro.html">PowerDNS&#39;s DNSSEC documentation</a>.</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 operates in Narrow or Inclusive mode.</p>
<p><strong>Note:</strong></p>
<p>For information about these modes, read <a href="https://doc.powerdns.com/authoritative/dnssec/intro.html">PowerDNS's DNSSEC documentation</a>.</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=1</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>Only use the <code>1</code> value 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>Only use the <code>1</code> value 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></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.</p>
<p><strong>Note:</strong></p>
<p>For information about salt values, read <a href="https://tools.ietf.org/html/rfc5155#section-3.1.5">RFC 5155</a>.</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.</p>
<p><strong>Note:</strong></p>
<p>For information about salt values, read <a href="https://tools.ietf.org/html/rfc5155#section-3.1.5">RFC 5155</a>.</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 this value, 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 this value, 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/enable_dnssec_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/enable_dnssec_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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
enable_dnssec_for_domains <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:R99956q:1" aria-labelledby="tab:R99956q: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: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">"data"</span>: <button class="collapser" aria-label="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 "><button class="collapser" aria-label="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">"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">"2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsec_error"</span>: <span class="token string">"Error message."</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">"metadata"</span>: <button class="collapser" aria-label="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">"enable_dnssec_for_domains"</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/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 domain's DNSSEC key<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function exports a DNSSEC security key to a domain.</p>
<p><strong>Note:</strong></p>
<p>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server
that doesn&#39;t use PowerDNS, you will receive an error.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function exports a DNSSEC security key to a domain.</p>
<p><strong>Note:</strong></p>
<p>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server
that doesn't use PowerDNS, you will receive an error.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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 to export the security key to.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain to export the security key to.</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></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>
<p><strong>Note:</strong></p>
<p>You can locate the ID with the WHM AP1 <code>fetch_ds_records_for_domains</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key's ID.</p>
<p><strong>Note:</strong></p>
<p>You can locate the ID with the WHM AP1 <code>fetch_ds_records_for_domains</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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">'1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b56q:1" aria-labelledby="tab:R99b56q: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: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">"data"</span>: <button class="collapser" aria-label="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_tag"</span>: <span class="token number">40481</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_type"</span>: <span class="token string">"CSK"</span></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">"command"</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">"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/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>Import DNSSEC key<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function imports a DNSSEC security key.</p>
<p><strong>Note:</strong></p>
<p>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server
that doesn&#39;t use PowerDNS, you will receive an error.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function imports a DNSSEC security key.</p>
<p><strong>Note:</strong></p>
<p>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server
that doesn't use PowerDNS, you will receive an error.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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 which to import the security key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to import the security key.</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&#39;s data that the
<a href="https://doc.powerdns.com/authoritative/manpages/pdnsutil.1.html">pdnsuti</a>
utility&#39;s <code>export-zone-key</code> call returns.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key's data that the
<a href="https://doc.powerdns.com/authoritative/manpages/pdnsutil.1.html">pdnsuti</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"> <!-- -->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> — Key-Signing Key</li>
<li><code>zsk</code> — Zone Signing Key</li>
</ul>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> call these values in lowercase.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key's type.</p>
<ul>
<li><code>ksk</code> — Key-Signing Key</li>
<li><code>zsk</code> — Zone Signing Key</li>
</ul>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> call these values in lowercase.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty import_zone_key <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">key_type</span><span class="token operator">=</span><span class="token string">'ksk'</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\(ECDSAP256SHA256\)%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d56q:1" aria-labelledby="tab:R99d56q: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: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">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"import_key_id"</span>: <span class="token number">1</span></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">"command"</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">"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/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 key<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes a DNSSEC security key.</p>
<p><strong>Note:</strong></p>
<p>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server
that doesn&#39;t use PowerDNS, you will receive an error.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a DNSSEC security key.</p>
<p><strong>Note:</strong></p>
<p>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server
that doesn't use PowerDNS, you will receive an error.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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 which to remove a security key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to remove a security key.</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>
<p><strong>Note:</strong></p>
<p>Use the WHM AP1 <code>fetch_ds_records_for_domains</code> function to locate the domain&#39;s
security key ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key's ID.</p>
<p><strong>Note:</strong></p>
<p>Use the WHM AP1 <code>fetch_ds_records_for_domains</code> function to locate the domain's
security key 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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99f56q:1" aria-labelledby="tab:R99f56q: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: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">"metadata"</span>: <button class="collapser" aria-label="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">"remove_zone_key"</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/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 domain's DNSSEC zone 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>Only servers that run PowerDNS can use DNSSEC. If you call this function on
a server that doesn&#39;t use PowerDNS, you will receive an error.</li>
<li>After you enable DNSSEC on the domain, you <strong>must</strong> add the Delegation of Signing (DS)
records to your zone record and your registrar.</li>
<li>You <strong>cannot</strong> modify the DNSSEC security key. To make any changes, you <strong>must</strong> disable,
delete, and re-create the DNSSEC security key.</li>
</ul>
" 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>Only servers that run PowerDNS can use DNSSEC. If you call this function on
a server that doesn't use PowerDNS, you will receive an error.</li>
<li>After you enable DNSSEC on the domain, you <strong>must</strong> add the Delegation of Signing (DS)
records to your zone record and your registrar.</li>
<li>You <strong>cannot</strong> modify the DNSSEC security key. To make any changes, you <strong>must</strong> disable,
delete, and re-create the DNSSEC security key.</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="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 new security key.</p>
<ul>
<li><code>1</code> — Activate.</li>
<li><code>0</code> — Do <strong>not</strong> activate.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to activate the new security key.</p>
<ul>
<li><code>1</code> — Activate.</li>
<li><code>0</code> — Do <strong>not</strong> activate.</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">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=13</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> — RSA SHA1-NSEC3-SHA1</li>
<li><code>8</code> — RSA/SHA-256</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 a <code>13</code> (ECDSA Curve P-256 with SHA-256) value 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> — RSA SHA1-NSEC3-SHA1</li>
<li><code>8</code> — RSA/SHA-256</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 a <code>13</code> (ECDSA Curve P-256 with SHA-256) value 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></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 enable DNSSEC.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for 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></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">256</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">384</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1024</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">key_size=256</span></div><div><div html="<p>The security key size, in bits.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the following values, depending on the <code>algo_num</code>
and <code>key_type</code> values:</p>
<ul>
<li><code>algo_num</code> = <code>5</code><ul>
<li><code>ksk</code> = <code>2048</code></li>
<li><code>zsk</code> = <code>1024</code></li>
</ul>
</li>
<li><code>algo_num</code> = <code>6</code><ul>
<li><code>ksk</code> = <code>2048</code></li>
<li><code>zsk</code> = <code>1024</code></li>
</ul>
</li>
<li><code>algo_num</code> = <code>7</code><ul>
<li><code>ksk</code> = <code>2048</code></li>
<li><code>zsk</code> = <code>1024</code></li>
</ul>
</li>
<li><code>algo_num</code> = <code>8</code><ul>
<li><code>ksk</code> = <code>2048</code></li>
<li><code>zsk</code> = <code>1024</code></li>
</ul>
</li>
<li><code>algo_num</code> = <code>13</code><ul>
<li><code>ksk</code> and <code>zsk</code> = <code>256</code></li>
</ul>
</li>
<li><code>algo_num</code> = <code>14</code><ul>
<li><code>ksk</code> and <code>zsk</code> = <code>384</code></li>
</ul>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key size, in bits.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the following values, depending on the <code>algo_num</code>
and <code>key_type</code> values:</p>
<ul>
<li><code>algo_num</code> = <code>5</code><ul>
<li><code>ksk</code> = <code>2048</code></li>
<li><code>zsk</code> = <code>1024</code></li>
</ul>
</li>
<li><code>algo_num</code> = <code>6</code><ul>
<li><code>ksk</code> = <code>2048</code></li>
<li><code>zsk</code> = <code>1024</code></li>
</ul>
</li>
<li><code>algo_num</code> = <code>7</code><ul>
<li><code>ksk</code> = <code>2048</code></li>
<li><code>zsk</code> = <code>1024</code></li>
</ul>
</li>
<li><code>algo_num</code> = <code>8</code><ul>
<li><code>ksk</code> = <code>2048</code></li>
<li><code>zsk</code> = <code>1024</code></li>
</ul>
</li>
<li><code>algo_num</code> = <code>13</code><ul>
<li><code>ksk</code> and <code>zsk</code> = <code>256</code></li>
</ul>
</li>
<li><code>algo_num</code> = <code>14</code><ul>
<li><code>ksk</code> and <code>zsk</code> = <code>384</code></li>
</ul>
</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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_type=ksk</span></div><div><div html="<p>The type of security key to add.</p>
<ul>
<li><code>ksk</code> — Key Signing Key.</li>
<li><code>zsk</code> — Zone Signing Key.</li>
</ul>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> call these values in lowercase.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of security key to add.</p>
<ul>
<li><code>ksk</code> — Key Signing Key.</li>
<li><code>zsk</code> — Zone Signing Key.</li>
</ul>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> call these values in lowercase.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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">'13'</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:R99h56q:1" aria-labelledby="tab:R99h56q: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: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">"data"</span>: <button class="collapser" aria-label="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_key_id"</span>: <span class="token string">"1"</span></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">"command"</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">"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/DNS-Zones" data-section-id="tag/DNS-Zones" 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-Zones" aria-label="tag/DNS-Zones"></a>DNS Zones</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>DNS / DNS Zones</p>
"><p>DNS / DNS Zones</p>
</div></div></div><div id="tag/DNS-Zones/operation/listzones" data-section-id="tag/DNS-Zones/operation/listzones" class="sc-dntaoT ceciOs"><div data-section-id="operation/listzones" id="operation/listzones" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Zones/operation/listzones" aria-label="tag/DNS-Zones/operation/listzones"></a>Return server's DNS zones<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the server&#39;s DNS zones.</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 lists the server's DNS zones.</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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/listzones</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/listzones</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99376q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99376q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99376q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99376q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99376q:0" aria-labelledby="tab:R99376q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
listzones
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99376q:1" aria-labelledby="tab:R99376q: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:R9p376q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p376q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p376q:0" aria-labelledby="tab:R9p376q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"zonefile"</span>: <span class="token string">"example.net.db"</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">"metadata"</span>: <button class="collapser" aria-label="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">"listzones"</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/DNS-Zones/operation/editzonerecord" data-section-id="tag/DNS-Zones/operation/editzonerecord" class="sc-dntaoT ceciOs"><div data-section-id="operation/editzonerecord" id="operation/editzonerecord" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Zones/operation/editzonerecord" aria-label="tag/DNS-Zones/operation/editzonerecord"></a>Update DNS zone record<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function edits a DNS zone record. To effectively use this function, use the following workflow:</p>
<ol>
<li>Run the <code>dumpzone</code> function on the DNS zone record to edit.</li>
<li>Locate the <code>Line</code> value that corresponds to the data to edit.</li>
<li>Use the values from that zone record to formulate the appropriate <code>editzonerecord</code> parameters.</li>
</ol>
<p><strong>Important:</strong></p>
<ul>
<li>When you call this function, you <strong>must</strong> include the additional parameters for the selected zone record type.</li>
<li>To change the zone record&#39;s IP address, we recommend that you use the <a href="https://go.cpanel.net/TheswapipScript"><code>swapip</code> script</a> or the <code>setsiteip</code> function instead.</li>
<li>You <strong>cannot</strong> edit other DNS zones that reside on <em>Write-only</em> servers in a DNS cluster.</li>
</ul>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of SPF resource records on DNS.</p>
<ul>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because <a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>. CentOS 7 servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the <a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles">DNS role</a>, the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function edits a DNS zone record. To effectively use this function, use the following workflow:</p>
<ol>
<li>Run the <code>dumpzone</code> function on the DNS zone record to edit.</li>
<li>Locate the <code>Line</code> value that corresponds to the data to edit.</li>
<li>Use the values from that zone record to formulate the appropriate <code>editzonerecord</code> parameters.</li>
</ol>
<p><strong>Important:</strong></p>
<ul>
<li>When you call this function, you <strong>must</strong> include the additional parameters for the selected zone record type.</li>
<li>To change the zone record's IP address, we recommend that you use the <a href="https://go.cpanel.net/TheswapipScript"><code>swapip</code> script</a> or the <code>setsiteip</code> function instead.</li>
<li>You <strong>cannot</strong> edit other DNS zones that reside on <em>Write-only</em> servers in a DNS cluster.</li>
</ul>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of SPF resource records on DNS.</p>
<ul>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because <a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>. CentOS 7 servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the <a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#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><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">application/x-www-form-urlencoded</span><div class="sc-CNKsk sc-hGZxvd sc-kLJHhQ hPAOR feFoaC fRACBr">required</div></h5><div html="<p>The updated DNS Zone Record.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>The updated DNS Zone Record.</p>
</div><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"> <!-- --><<!-- -->ipv4<!-- -->><!-- --> </span></div> <div><div html="<p>The zone record&#39;s IPv4 address.</p>
<p><strong>Note:</strong></p>
<p>For more information about A records, read <a href="http://tools.ietf.org/html/rfc1035">RFC 1035 at IANA</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone record's IPv4 address.</p>
<p><strong>Note:</strong></p>
<p>For more information about A records, read <a href="http://tools.ietf.org/html/rfc1035">RFC 1035 at IANA</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><div html="<p>The zone record&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone record's domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="line" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">line</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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><div html="<p>The zone record&#39;s file line number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone record's file line number.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="ttl" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ttl</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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><div html="<p>The record&#39;s Time To Live (TTL), in seconds.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The record's Time To Live (TTL), in seconds.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="class" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand class"><span class="property-name">class</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 record&#39;s class.</p>
<p>If you do not use this parameter, the system retains the current setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The record's class.</p>
<p>If you do not use this parameter, the system retains the current setting.</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><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->domain<!-- -->><!-- --> </span></div> <div><div html="<p>The record&#39;s name.</p>
<p>If you do not use this parameter, the system retains the current setting.</p>
<p><strong>Note:</strong></p>
<p>Do <strong>not</strong> omit any necessary trailing periods.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The record's name.</p>
<p>If you do not use this parameter, the system retains the current setting.</p>
<p><strong>Note:</strong></p>
<p>Do <strong>not</strong> omit any necessary trailing periods.</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><div html="<p>The <a href="https://en.wikipedia.org/wiki/List_of_DNS_record_types">DNS record type</a>:</p>
<ul>
<li><code>A</code> - A records store IPv4 addresses. Use them to map a hostname to an IPv4 address.</li>
<li><code>A6</code> - A6 records store IPv6 addresses.</li>
<li><code>AAAA</code> - AAAA records store IPv6 addresses.</li>
<li><code>AFSDB</code> - AFSDB records store the location of an AFS cell&#39;s database servers.</li>
<li><code>ALIAS</code> - ALIAS records create an alias to another hostname, but can coexist with other records on that name. We strongly discourage using this record type.</li>
<li><code>CAA</code> - CAA records control which certificate authorities can issue SSL certificates for a domain.</li>
<li><code>CNAME</code> - CNAME records create an alias to another hostname.</li>
<li><code>DNAME</code> - DNAME records create an alias for a hostname and its subnames.</li>
<li><code>DS</code> - DS records specify a record&#39;s delegation signer.</li>
<li><code>HINFO</code> - HINFO records specify a host&#39;s CPU and OS types.</li>
<li><code>LOC</code> - LOC records store a hostname&#39;s geographical location.</li>
<li><code>MX</code> - MX records point a domain name to its MTAs.</li>
<li><code>NS</code> - NS records store a domain&#39;s authoritative nameservers.</li>
<li><code>PTR</code> - PTR records point to a CNAME.</li>
<li><code>RP</code> - RP records store a domain&#39;s Responsible Person&#39;s information.</li>
<li><code>SOA</code> - SOA records designate the beginning of a zone of authority.</li>
<li><code>SRV</code> - SRV records store the service location records for newer protocols (for example, Autodiscover).</li>
<li><code>TXT</code> - TXT records store descriptive text or useful records (for example, SPF or DKIM records).</li>
</ul>
<p>If you do not use this parameter, the system retains the current setting.</p>
<p><strong>Warning:</strong></p>
<p>Additional properties may be required based on the <code>type</code>.</p>
<p>When you call this function, you <strong>must</strong> include the additional parameters for the desired
zone record type if you use this parameter. Select a zone record from the menu to view the required additional
parameters:</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://en.wikipedia.org/wiki/List_of_DNS_record_types">DNS record type</a>:</p>
<ul>
<li><code>A</code> - A records store IPv4 addresses. Use them to map a hostname to an IPv4 address.</li>
<li><code>A6</code> - A6 records store IPv6 addresses.</li>
<li><code>AAAA</code> - AAAA records store IPv6 addresses.</li>
<li><code>AFSDB</code> - AFSDB records store the location of an AFS cell's database servers.</li>
<li><code>ALIAS</code> - ALIAS records create an alias to another hostname, but can coexist with other records on that name. We strongly discourage using this record type.</li>
<li><code>CAA</code> - CAA records control which certificate authorities can issue SSL certificates for a domain.</li>
<li><code>CNAME</code> - CNAME records create an alias to another hostname.</li>
<li><code>DNAME</code> - DNAME records create an alias for a hostname and its subnames.</li>
<li><code>DS</code> - DS records specify a record's delegation signer.</li>
<li><code>HINFO</code> - HINFO records specify a host's CPU and OS types.</li>
<li><code>LOC</code> - LOC records store a hostname's geographical location.</li>
<li><code>MX</code> - MX records point a domain name to its MTAs.</li>
<li><code>NS</code> - NS records store a domain's authoritative nameservers.</li>
<li><code>PTR</code> - PTR records point to a CNAME.</li>
<li><code>RP</code> - RP records store a domain's Responsible Person's information.</li>
<li><code>SOA</code> - SOA records designate the beginning of a zone of authority.</li>
<li><code>SRV</code> - SRV records store the service location records for newer protocols (for example, Autodiscover).</li>
<li><code>TXT</code> - TXT records store descriptive text or useful records (for example, SPF or DKIM records).</li>
</ul>
<p>If you do not use this parameter, the system retains the current setting.</p>
<p><strong>Warning:</strong></p>
<p>Additional properties may be required based on the <code>type</code>.</p>
<p>When you call this function, you <strong>must</strong> include the additional parameters for the desired
zone record type if you use this parameter. Select a zone record from the menu to view the required additional
parameters:</p>
</div></div><div class="sc-diYFot jsRqjj"><svg class="sc-kZrBCu bweot" 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="AAAA">AAAA</option><option value="AFSDB">AFSDB</option><option value="ALIAS">ALIAS</option><option value="CNAME">CNAME</option><option value="DS">DS</option><option value="LOC">LOC</option><option value="NS">NS</option><option value="RP">RP</option><option value="SRV">SRV</option><option value="A6">A6</option><option value="A" selected="">A</option><option value="CAA">CAA</option><option value="DNAME">DNAME</option><option value="HINFO">HINFO</option><option value="MX">MX</option><option value="PTR">PTR</option><option value="SOA">SOA</option><option value="TXT">TXT</option></select><label>A</label></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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/editzonerecord</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/editzonerecord</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99576q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99576q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99576q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99576q: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:R99576q:0" aria-labelledby="tab:R99576q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <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>
editzonerecord
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99576q:1" aria-labelledby="tab:R99576q: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:R9p576q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p576q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p576q:0" aria-labelledby="tab:R9p576q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"editzonerecord"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Bind reloading on hostname using rndc zone: [example.com]\n"</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/DNS-Zones/operation/removezonerecord" data-section-id="tag/DNS-Zones/operation/removezonerecord" class="sc-dntaoT ceciOs"><div data-section-id="operation/removezonerecord" id="operation/removezonerecord" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Zones/operation/removezonerecord" aria-label="tag/DNS-Zones/operation/removezonerecord"></a>Delete DNS zone record<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deletes a DNS zone record.</p>
<p><strong>Warning:</strong></p>
<p>Incorrect use of this function could cause domains to resolve incorrectly. Exercise <strong>extreme caution</strong> when you remove DNS zone records.</p>
<p>To effectively use this function, use the following workflow:</p>
<ol>
<li>Run the <code>dumpzone</code> function.</li>
<li>Locate the <code>Line</code> value that corresponds to the zone record to delete.</li>
<li>Use the values from that zone record to formulate the appropriate <code>removezonerecord</code> parameters.</li>
</ol>
<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 DNS zone record.</p>
<p><strong>Warning:</strong></p>
<p>Incorrect use of this function could cause domains to resolve incorrectly. Exercise <strong>extreme caution</strong> when you remove DNS zone records.</p>
<p>To effectively use this function, use the following workflow:</p>
<ol>
<li>Run the <code>dumpzone</code> function.</li>
<li>Locate the <code>Line</code> value that corresponds to the zone record to delete.</li>
<li>Use the values from that zone record to formulate the appropriate <code>removezonerecord</code> parameters.</li>
</ol>
<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="line" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">line</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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">line=4</span></div><div><div html="<p>The DNS zone record file&#39;s line number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The DNS zone record file's line number.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="serialnum" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">serialnum</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">serialnum=2013122501</span></div><div><div html="<p>The zone file&#39;s serial number.</p>
<p>This parameter defaults to the zone file&#39;s current serial number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone file's serial number.</p>
<p>This parameter defaults to the zone file's current serial number.</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><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">zone=example.com</span></div><div><div html="<p>The zone record&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone record'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="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">/removezonerecord</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/removezonerecord</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99776q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99776q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99776q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99776q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99776q:0" aria-labelledby="tab:R99776q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
removezonerecord <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> <span class="token punctuation">\</span>
<span class="token assign-left variable">line</span><span class="token operator">=</span><span class="token string">'4'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99776q:1" aria-labelledby="tab:R99776q: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:R9p776q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p776q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p776q:0" aria-labelledby="tab:R9p776q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"removezonerecord"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Bind reloading on hostname using rndc zone: [example.com]\n"</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/DNS-Zones/operation/export_zone_dnskey" data-section-id="tag/DNS-Zones/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-Zones/operation/export_zone_dnskey" aria-label="tag/DNS-Zones/operation/export_zone_dnskey"></a>Export domain's DNSKEY record value<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function exports a domain&#39;s DNSKEY record value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function exports a domain's DNSKEY record value.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99976q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99976q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99976q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99976q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99976q:0" aria-labelledby="tab:R99976q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99976q:1" aria-labelledby="tab:R99976q: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:R9p976q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p976q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p976q:0" aria-labelledby="tab:R9p976q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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></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">"command"</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">"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/DNS-Zones/operation/update_reverse_dns_cache" data-section-id="tag/DNS-Zones/operation/update_reverse_dns_cache" class="sc-dntaoT ceciOs"><div data-section-id="operation/update_reverse_dns_cache" id="operation/update_reverse_dns_cache" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Zones/operation/update_reverse_dns_cache" aria-label="tag/DNS-Zones/operation/update_reverse_dns_cache"></a>Update reverse DNS cache<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function queries DNS and updates the map of local IP addresses to reverse DNS names.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function queries DNS and updates the map of local IP addresses to reverse DNS 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/update_reverse_dns_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/update_reverse_dns_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:R99b76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b76q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b76q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b76q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b76q:0" aria-labelledby="tab:R99b76q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
update_reverse_dns_cache
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b76q:1" aria-labelledby="tab:R99b76q: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:R9pb76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb76q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb76q:0" aria-labelledby="tab:R9pb76q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"update_reverse_dns_cache"</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/DNS-Zones/operation/getzonerecord" data-section-id="tag/DNS-Zones/operation/getzonerecord" class="sc-dntaoT ceciOs"><div data-section-id="operation/getzonerecord" id="operation/getzonerecord" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Zones/operation/getzonerecord" aria-label="tag/DNS-Zones/operation/getzonerecord"></a>Return specific line from domain's DNS configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a line from a domain&#39;s DNS zone configuration.</p>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a named warning about the absence of SPF resource records on DNS.</p>
<ul>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because <a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>. CentOS 7 servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the <a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</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 returns a line from a domain's DNS zone configuration.</p>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a named warning about the absence of SPF resource records on DNS.</p>
<ul>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because <a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>. CentOS 7 servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the <a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</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="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 zone record&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone record's domain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="line" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">line</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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">line=2</span></div><div><div html="<p>The zone record&#39;s line number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone record's line 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/getzonerecord</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/getzonerecord</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d76q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d76q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d76q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d76q:0" aria-labelledby="tab:R99d76q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
getzonerecord <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">line</span><span class="token operator">=</span><span class="token string">'2'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d76q:1" aria-labelledby="tab:R99d76q: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:R9pd76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd76q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd76q:0" aria-labelledby="tab:R9pd76q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"record"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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"</span>: <span class="token number">24</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"class"</span>: <span class="token string">"IN"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</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">"ttl"</span>: <span class="token number">86400</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"A"</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">"metadata"</span>: <button class="collapser" aria-label="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">"getzonerecord"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Record obtained."</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/DNS-Zones/operation/cluster_member_has_trust_with" data-section-id="tag/DNS-Zones/operation/cluster_member_has_trust_with" class="sc-dntaoT ceciOs"><div data-section-id="operation/cluster_member_has_trust_with" id="operation/cluster_member_has_trust_with" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Zones/operation/cluster_member_has_trust_with" aria-label="tag/DNS-Zones/operation/cluster_member_has_trust_with"></a>Return whether DNS cluster server can share records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function queries whether nameservers in a DNS cluster can share records with one another. Servers in a DNS cluster <strong>must</strong> exist in a <a href="https://go.cpanel.net/whmdocsDNSCluster">Reverse Trust relationship</a> to share information. This relationship requires each server to have an <a href="https://go.cpanel.net/ManageAPITokens">API token</a>.</p>
<p><strong>Note:</strong></p>
<p> DNS servers in a Write-Only role do not need to exist in a Reverse Trust relationship. For more information, read our <a href="https://go.cpanel.net/DNSClusterConfig">Guide to DNS Cluster Configurations</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function queries whether nameservers in a DNS cluster can share records with one another. Servers in a DNS cluster <strong>must</strong> exist in a <a href="https://go.cpanel.net/whmdocsDNSCluster">Reverse Trust relationship</a> to share information. This relationship requires each server to have an <a href="https://go.cpanel.net/ManageAPITokens">API token</a>.</p>
<p><strong>Note:</strong></p>
<p> DNS servers in a Write-Only role do not need to exist in a Reverse Trust relationship. For more information, read our <a href="https://go.cpanel.net/DNSClusterConfig">Guide to DNS Cluster Configurations</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="althost" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">althost</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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"> <!-- -->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">althost=192.0.3.0</span></div><div><div html="<p>The nameserver&#39;s alternate IP address. This is useful, for example, if your DNS cluster exists in a NAT-configured network.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The nameserver's alternate IP address. This is useful, for example, if your DNS cluster exists in a NAT-configured network.</p>
</div></div></div></td></tr><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><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">host=192.0.2.0</span></div><div><div html="<p>The nameserver&#39;s IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The nameserver's IP 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/cluster_member_has_trust_with</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/cluster_member_has_trust_with</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f76q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f76q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f76q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f76q:0" aria-labelledby="tab:R99f76q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
cluster_member_has_trust_with <span class="token punctuation">\</span>
<span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'192.0.2.0'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f76q:1" aria-labelledby="tab:R99f76q: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:R9pf76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf76q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf76q:0" aria-labelledby="tab:R9pf76q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_trust"</span>: <span class="token number">1</span></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">"command"</span>: <span class="token string">"cluster_member_has_trust_with"</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/DNS-Zones/operation/killdns" data-section-id="tag/DNS-Zones/operation/killdns" class="sc-dntaoT ceciOs"><div data-section-id="operation/killdns" id="operation/killdns" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Zones/operation/killdns" aria-label="tag/DNS-Zones/operation/killdns"></a>Delete DNS zone<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deletes a DNS zone.</p>
<p><strong>Important:</strong></p>
<ul>
<li>The WHM API 1 adddns function adds an XDNS entry for a domain in the following locations:</li>
<li>The <code>/var/cpanel/users/USER</code> file, where <code>USER</code> represents the domain&#39;s owner.</li>
<li>The <code>/etc/vdomainaliases/DOMAIN</code> directory, where <code>DOMAIN</code> represents the new zone&#39;s domain.</li>
<li>The <code>/etc/vfilters/DOMAIN</code> directory, where <code>DOMAIN</code> represents the new zone&#39;s domain.</li>
<li>This function does <strong>not</strong> automatically delete these entries. You <strong>must</strong> manually delete these entries, or you <strong>cannot</strong> use this domain as a value in other API functions.</li>
<li>You cannot delete other DNS zones that reside on <em>Write-only</em> servers in a DNS cluster.</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 deletes a DNS zone.</p>
<p><strong>Important:</strong></p>
<ul>
<li>The WHM API 1 adddns function adds an XDNS entry for a domain in the following locations:</li>
<li>The <code>/var/cpanel/users/USER</code> file, where <code>USER</code> represents the domain's owner.</li>
<li>The <code>/etc/vdomainaliases/DOMAIN</code> directory, where <code>DOMAIN</code> represents the new zone's domain.</li>
<li>The <code>/etc/vfilters/DOMAIN</code> directory, where <code>DOMAIN</code> represents the new zone's domain.</li>
<li>This function does <strong>not</strong> automatically delete these entries. You <strong>must</strong> manually delete these entries, or you <strong>cannot</strong> use this domain as a value in other API functions.</li>
<li>You cannot delete other DNS zones that reside on <em>Write-only</em> servers in a DNS cluster.</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> <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 zone record&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone record'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="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">/killdns</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/killdns</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99h76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h76q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h76q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h76q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h76q:0" aria-labelledby="tab:R99h76q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
killdns <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:R99h76q:1" aria-labelledby="tab:R99h76q: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:R9ph76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph76q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph76q:0" aria-labelledby="tab:R9ph76q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"killdns"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"raw"</span>: <span class="token string">"example.com => deleted from 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">"Zones Removed"</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/DNS-Zones/operation/dumpzone" data-section-id="tag/DNS-Zones/operation/dumpzone" class="sc-dntaoT ceciOs"><div data-section-id="operation/dumpzone" id="operation/dumpzone" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Zones/operation/dumpzone" aria-label="tag/DNS-Zones/operation/dumpzone"></a>Return domain's DNS zone configuration<!-- --> <span type="warning" class="sc-jtQUzJ jmDXKf"> Deprecated </span></h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a domain&#39;s DNS zone configuration.</p>
<p><strong>Important:</strong></p>
<ul>
<li>This function is <strong>deprecated</strong>. Use WHM&#39;s <code>parse_dns_zone</code> function.</li>
<li>You <strong>must</strong> include either the <code>domain</code> or the <code>zone</code> parameters. </li>
<li>When you disable the <a href="https://go.cpanel.net/serverroles">DNS role</a>, the
system <strong>disables</strong> this function.</li>
</ul>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of
SPF resource records on DNS.</p>
<ul>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because
<a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>. CentOS 7
servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an
updated version of BIND that complies with RFC 7208. To resolve this issue,
update your operating system to a version that contains the updated version of
BIND. For more information, read the
<a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a domain's DNS zone configuration.</p>
<p><strong>Important:</strong></p>
<ul>
<li>This function is <strong>deprecated</strong>. Use WHM's <code>parse_dns_zone</code> function.</li>
<li>You <strong>must</strong> include either the <code>domain</code> or the <code>zone</code> parameters. </li>
<li>When you disable the <a href="https://go.cpanel.net/serverroles">DNS role</a>, the
system <strong>disables</strong> this function.</li>
</ul>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of
SPF resource records on DNS.</p>
<ul>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because
<a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>. CentOS 7
servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an
updated version of BIND that complies with RFC 7208. To resolve this issue,
update your operating system to a version that contains the updated version of
BIND. For more information, read the
<a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</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 zone record&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone record's domain.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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.db</span></div><div><div html="<p>The zone file&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone file'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/dumpzone</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/dumpzone</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99j76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j76q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j76q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j76q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j76q:0" aria-labelledby="tab:R99j76q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
dumpzone <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:R99j76q:1" aria-labelledby="tab:R99j76q: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:R9pj76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj76q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj76q:0" aria-labelledby="tab:R9pj76q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"192.168.0.20"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"A"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Line"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"class"</span>: <span class="token string">"IN"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</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">"ttl"</span>: <span class="token number">86400</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">"metadata"</span>: <button class="collapser" aria-label="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">"dumpzone"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Zone Serialized"</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/DNS-Zones/operation/export_zone_files" data-section-id="tag/DNS-Zones/operation/export_zone_files" class="sc-dntaoT ceciOs"><div data-section-id="operation/export_zone_files" id="operation/export_zone_files" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Zones/operation/export_zone_files" aria-label="tag/DNS-Zones/operation/export_zone_files"></a>Export DNS zones in zone file format<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns one or more DNS zones, in
<a href="https://tools.ietf.org/html/rfc1035">RFC-1035</a> format.</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 returns one or more DNS zones, in
<a href="https://tools.ietf.org/html/rfc1035">RFC-1035</a> format.</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="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">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->domain<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->domain<!-- --> ></span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">zone=example.com&zone=example.net</span></div><div><div html="<p>The DNS zones to display.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The DNS zones to display.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/export_zone_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/export_zone_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:R99l76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99l76q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99l76q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l76q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99l76q:0" aria-labelledby="tab:R99l76q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
export_zone_files <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> <span class="token assign-left variable">zone</span><span class="token operator">=</span><span class="token string">'example.net'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l76q:1" aria-labelledby="tab:R99l76q: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:R9pl76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pl76q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pl76q:0" aria-labelledby="tab:R9pl76q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"text_b64"</span>: <span class="token string">"AAAABBCCDdshjke=="</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">"text_b64"</span>: <span class="token string">"BBBBCCDDDdshjke=="</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"zone"</span>: <span class="token string">"example.net"</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">"metadata"</span>: <button class="collapser" aria-label="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">"export_zone_files"</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/DNS-Zones/operation/parse_dns_zone" data-section-id="tag/DNS-Zones/operation/parse_dns_zone" class="sc-dntaoT ceciOs"><div data-section-id="operation/parse_dns_zone" id="operation/parse_dns_zone" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Zones/operation/parse_dns_zone" aria-label="tag/DNS-Zones/operation/parse_dns_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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/parse_dns_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/parse_dns_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:R99n76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99n76q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99n76q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n76q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99n76q:0" aria-labelledby="tab:R99n76q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 parse_dns_zone <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:R99n76q:1" aria-labelledby="tab:R99n76q: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:R9pn76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pn76q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pn76q:0" aria-labelledby="tab:R9pn76q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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></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">"command"</span>: <span class="token string">"parse_dns_zone"</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/DNS-Zones/operation/mass_edit_dns_zone" data-section-id="tag/DNS-Zones/operation/mass_edit_dns_zone" class="sc-dntaoT ceciOs"><div data-section-id="operation/mass_edit_dns_zone" id="operation/mass_edit_dns_zone" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Zones/operation/mass_edit_dns_zone" aria-label="tag/DNS-Zones/operation/mass_edit_dns_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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/mass_edit_dns_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/mass_edit_dns_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:R99p76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99p76q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99p76q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99p76q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99p76q:0" aria-labelledby="tab:R99p76q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 mass_edit_dns_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":["11.22.33.44"]}'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99p76q:1" aria-labelledby="tab:R99p76q: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:R9pp76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pp76q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pp76q:0" aria-labelledby="tab:R9pp76q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"metadata"</span>: <button class="collapser" aria-label="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">"mass_edit_dns_zone"</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/DNS-Zones/operation/adddns" data-section-id="tag/DNS-Zones/operation/adddns" class="sc-dntaoT ceciOs"><div data-section-id="operation/adddns" id="operation/adddns" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Zones/operation/adddns" aria-label="tag/DNS-Zones/operation/adddns"></a>Create DNS zone<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates a DNS zone. If <code>trueowner=user</code>, this function does the following:</p>
<ul>
<li>Adds a DNS entry in the <code>/var/cpanel/users/USER</code> file, where <code>USER</code> represents the <code>trueowner</code> parameter&#39;s value.</li>
<li>Creates the <code>/etc/vdomainaliases/DOMAIN</code> file, where <code>DOMAIN</code> represents the new zone&#39;s domain.</li>
<li>Creates the <code>/etc/vfilters/DOMAIN</code> file, where <code>DOMAIN</code> represents the new zone&#39;s domain.</li>
</ul>
<p>When you call this function, the system uses the domain name and IP address that you supply. WHM&#39;s standard zone template determines all other zone information.</p>
<p>This function generates the DNS zone&#39;s <a href="https://en.wikipedia.org/wiki/MX_record">MX record</a>, <a href="https://en.wikipedia.org/wiki/Reverse_DNS_lookup#Multiple_pointer_records">domain PTR</a>, and <a href="https://en.wikipedia.org/wiki/List_of_DNS_record_types#A">A records</a> automatically.</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 creates a DNS zone. If <code>trueowner=user</code>, this function does the following:</p>
<ul>
<li>Adds a DNS entry in the <code>/var/cpanel/users/USER</code> file, where <code>USER</code> represents the <code>trueowner</code> parameter's value.</li>
<li>Creates the <code>/etc/vdomainaliases/DOMAIN</code> file, where <code>DOMAIN</code> represents the new zone's domain.</li>
<li>Creates the <code>/etc/vfilters/DOMAIN</code> file, where <code>DOMAIN</code> represents the new zone's domain.</li>
</ul>
<p>When you call this function, the system uses the domain name and IP address that you supply. WHM's standard zone template determines all other zone information.</p>
<p>This function generates the DNS zone's <a href="https://en.wikipedia.org/wiki/MX_record">MX record</a>, <a href="https://en.wikipedia.org/wiki/Reverse_DNS_lookup#Multiple_pointer_records">domain PTR</a>, and <a href="https://en.wikipedia.org/wiki/List_of_DNS_record_types#A">A records</a> automatically.</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 new zone&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new zone's domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="has_ipv6" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">has_ipv6</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">has_ipv6=1</span></div><div><div html="<p>Whether to add an IPv6 address to the new zone.</p>
<ul>
<li><code>1</code> — Add the IPv6 address in the <code>ipv6</code> parameter to the new zone.</li>
<li><code>0</code> — Do <strong>not</strong> add an IPv6 address to the new zone.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to add an IPv6 address to the new zone.</p>
<ul>
<li><code>1</code> — Add the IPv6 address in the <code>ipv6</code> parameter to the new zone.</li>
<li><code>0</code> — Do <strong>not</strong> add an IPv6 address to the new zone.</li>
</ul>
</div></div></div></td></tr><tr class=""><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><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">ip=192.168.0.20</span></div><div><div html="<p>The domain&#39;s IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain's IP address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="ipv6" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ipv6</span></td><td 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"> <!-- --><<!-- -->ipv6<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ipv6=2001:0db8:0:0:1:0:0:1</span></div><div><div html="<p>The domain&#39;s IPv6 address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain's IPv6 address.</p>
</div></div></div></td></tr><tr class=""><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"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"standard"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">template=standard</span></div><div><div html="<p>The zone file template.</p>
<ul>
<li><code>standard</code></li>
<li><code>simple</code></li>
<li><code>standardvirtualftp</code></li>
<li>The name of a custom zone template file in the <code>/var/cpanel/zonetemplates</code> directory.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone file template.</p>
<ul>
<li><code>standard</code></li>
<li><code>simple</code></li>
<li><code>standardvirtualftp</code></li>
<li>The name of a custom zone template file in the <code>/var/cpanel/zonetemplates</code> directory.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="trueowner" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">trueowner</span></td><td 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"> <!-- --><<!-- -->username<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">trueowner=user</span></div><div><div html="<p>The new zone&#39;s owner. This parameter defaults to the currently-authenticated user.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new zone's owner. 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="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">/adddns</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/adddns</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99r76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99r76q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99r76q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99r76q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99r76q:0" aria-labelledby="tab:R99r76q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
adddns <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">trueowner</span><span class="token operator">=</span><span class="token string">'user'</span> <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.20'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99r76q:1" aria-labelledby="tab:R99r76q: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:R9pr76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pr76q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pr76q:0" aria-labelledby="tab:R9pr76q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"adddns"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Added example.com ok belonging to user user"</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/Domain-Management" data-section-id="tag/Domain-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/Domain-Management" aria-label="tag/Domain-Management"></a>Domain Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>DNS / Domain Management</p>
"><p>DNS / Domain Management</p>
</div></div></div><div id="tag/Domain-Management/operation/DNS::is_alias_available" data-section-id="tag/Domain-Management/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/Domain-Management/operation/DNS::is_alias_available" aria-label="tag/Domain-Management/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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
is_alias_available
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99396q:1" aria-labelledby="tab:R99396q: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: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">"data"</span>: <button class="collapser" aria-label="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">"metadata"</span>: <button class="collapser" aria-label="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">"is_alias_available"</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/Domain-Management/operation/fetch_ds_records_for_domains" data-section-id="tag/Domain-Management/operation/fetch_ds_records_for_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_ds_records_for_domains" id="operation/fetch_ds_records_for_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Management/operation/fetch_ds_records_for_domains" aria-label="tag/Domain-Management/operation/fetch_ds_records_for_domains"></a>Return domain's DS record<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function fetches a domain&#39;s Delegation of Signing (DS) record.</p>
<p><strong>Note:</strong></p>
<p>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn&#39;t use PowerDNS, you will receive an error.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function fetches a domain's Delegation of Signing (DS) record.</p>
<p><strong>Note:</strong></p>
<p>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn't use PowerDNS, you will receive an error.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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 fetch a DS record from.</p>
<p><strong>Note:</strong></p>
<p>To fetch records from multiple domains, duplicate or increment the parameter name. For example, to check 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 fetch a DS record from.</p>
<p><strong>Note:</strong></p>
<p>To fetch records from multiple domains, duplicate or increment the parameter name. For example, to check 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/fetch_ds_records_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/fetch_ds_records_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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
fetch_ds_records_for_domains <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:R99596q:1" aria-labelledby="tab:R99596q: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: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">"data"</span>: <button class="collapser" aria-label="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 "><button class="collapser" aria-label="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">"ds_records"</span>: <button class="collapser" aria-label="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">"40481"</span>: <button class="collapser" aria-label="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 number">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">2048</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1575395316</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"digests"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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">"algo_num"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"digest"</span>: <span class="token string">"2808a14b89118256119d93d24b9e6b673dca092b"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"algo_desc"</span>: <span class="token string">"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 number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"digest"</span>: <span class="token string">"02a57812deb952438382ed8dd20f00d4af844a55b5324d28bb"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"algo_desc"</span>: <span class="token string">"SHA-384"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"algo_num"</span>: <span class="token number">4</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"digest"</span>: <span class="token string">"4569a6fcfe9e151ec6a163307e67eaa3a9547f16cd80751b0d46eb498bd96743bd4ff7c4f6fd5f76cc780aeb979cd08d"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"flags"</span>: <span class="token number">257</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_tag"</span>: <span class="token number">40481</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">"privatekey"</span>: <span class="token string">"Private-key-format: v1.2\nAlgorithm: 8 (RSASHA256)\nModulus: syUlztxieV1aOtuYAGGA4VBxgquwqPTWQXcDVY1VRFcPgFmLMWYr6dDnN4OUhu2yIulK3KMeZmAc/DmwM+yNdCdYc9y84gw5OyONKduuPGYXfwCiJfOJ+NpGaFomK6fVFN8BMi6LUBytdA4gotPw45Uz8FIbl1KsEOnV4/ZpjiM=\nPublicExponent: AQAB\nPrivateExponent: LxIfsQ7vQPxqbPSuJ8t21b0RVkhOjtZmRaVD1wLf2KkXhZ4BmOVDvJgLaObF6/4gxFOQPBEQN84hT5TI25vYPrAwRAlP/yGmQ4Z2aPIYeEawoqqNoYEa5Xjs1X90i6/+Y8mJSZpGvr4/Y4ElothZTUw+LCYb6o9ulg53yya8KUE=\nPrime1: 4od92Rbx9fSXRIk6eSSdTYN/Do3zgDiCuxmuZaCrrEAlkiK11iz/s4aZGj9+Yk4NfusjXr3NqU1OMfBiIp67Sw==\nPrime2: ynOJdz/E4/B6iBtuz/4y0kasljMtiJnaNIxPr4LG+hByx7WWCnaPm6p8g1pz3FC/w7HAdWq9xzR1VnbRPGcZiQ==\nExponent1: KUKmkIEWZ0c6ujgIl4IsyK6X2O3QGV2xqiSeWFJwknpInZqG5lDh7jAo+NfxzDQNTz3C/oGx0RGMmZoANfAViw==\nExponent2: ZcFkmpdmstqv+7EuJUSy7pWvMV9Px5Ts4/SSKLkmoZGa314Zp/CnhapPIwZXrai4effhsCKSeImZYHgf+qgnYQ==\nCoefficient: PBQUQquZB0kG//cy8oVA6nHvKkvVJ8zV4GVlkXHTDylbjoWBTuNWwQ93t5SM7Rz3JePHImWdOVMYNIXpPlp56g==\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">"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 number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsec3_iterations"</span>: <span class="token number">7</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 number">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">"1a2b3c4d5e6f"</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></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">"command"</span>: <span class="token string">"fetch_ds_records_for_domains"</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/Domain-Management/operation/has_local_authority" data-section-id="tag/Domain-Management/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/Domain-Management/operation/has_local_authority" aria-label="tag/Domain-Management/operation/has_local_authority"></a>Validate local server is authoritative<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks whether the local server has the authority to publish changes for the domain&#39;s DNS records.</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 checks whether the local server has the authority to publish changes for the domain's DNS records.</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="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-1=example1.com domain-2=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 whether the local server is authoritative for the domain&#39;s DNS records.</p>
<p><strong>Note:</strong></p>
<p>To check multiple domains, duplicate or increment the parameter name. For example, to check three domains, use the <code>domain</code> parameter multiple times. Or the <code>domain</code>, <code>domain-1</code>, and <code>domain-2</code> parameters.</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, duplicate or increment the parameter name. For example, to check three domains, use the <code>domain</code> parameter multiple times. Or the <code>domain</code>, <code>domain-1</code>, and <code>domain-2</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99796q:1" aria-labelledby="tab:R99796q: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: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">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"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 qdbmuk) 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">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></ul><span class="token punctuation">]</span></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">"command"</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">"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/Domain-Management/operation/resetzone" data-section-id="tag/Domain-Management/operation/resetzone" class="sc-dntaoT ceciOs"><div data-section-id="operation/resetzone" id="operation/resetzone" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Management/operation/resetzone" aria-label="tag/Domain-Management/operation/resetzone"></a>Restore DNS zone to default values<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function resets a DNS zone to its default values. This also resets the domain&#39;s subdomain DNS records, and restores zone file subdomains in the server&#39;s <code>httpd.conf</code> file. For example, use this function to restore DNS zones that are corrupt.</p>
<p><strong>Note:</strong></p>
<p>Zone resets preserve valid TXT records, but <strong>all</strong> other records will return to their default values.</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>
<p><strong>Note</strong></p>
<p>You <strong>must</strong> include either the <code>domain</code> or the <code>zone</code> parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function resets a DNS zone to its default values. This also resets the domain's subdomain DNS records, and restores zone file subdomains in the server's <code>httpd.conf</code> file. For example, use this function to restore DNS zones that are corrupt.</p>
<p><strong>Note:</strong></p>
<p>Zone resets preserve valid TXT records, but <strong>all</strong> other records will return to their default values.</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>
<p><strong>Note</strong></p>
<p>You <strong>must</strong> include either the <code>domain</code> or the <code>zone</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="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.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain.</p>
</div></div></div></td></tr><tr class=""><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 domain&#39;s owner.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain's owner.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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.db</span></div><div><div html="<p>The zone file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone 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="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">/resetzone</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/resetzone</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" 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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
resetzone
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99996q:1" aria-labelledby="tab:R99996q: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: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">"metadata"</span>: <button class="collapser" aria-label="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">"resetzone"</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/Domain-Management/operation/savemxs" data-section-id="tag/Domain-Management/operation/savemxs" class="sc-dntaoT ceciOs"><div data-section-id="operation/savemxs" id="operation/savemxs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Management/operation/savemxs" aria-label="tag/Domain-Management/operation/savemxs"></a>Create mail exchanger record<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates a new MX record.</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 creates a new MX record.</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="class" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">class</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"IN"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">class=IN</span></div><div><div html="<p>The record&#39;s class.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The record's class.</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 zone record&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone record's domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="exchange" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">exchange</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">exchange=mail.example.com</span></div><div><div html="<p>The domain&#39;s mail exchanger.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain's mail exchanger.</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=mail.example.com</span></div><div><div html="<p>The record name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The record name.</p>
</div></div></div></td></tr><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">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">preference=20</span></div><div><div html="<p>The MX record&#39;s priority order.</p>
<p><strong>Note:</strong></p>
<p>Lower numbers indicate a higher priority order.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MX record's priority order.</p>
<p><strong>Note:</strong></p>
<p>Lower numbers indicate a higher priority order.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="ttl" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ttl</span></td><td class="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">14400</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ttl=14400</span></div><div><div html="<p>The record&#39;s Time To Live (TTL) in seconds.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The record's Time To Live (TTL) in seconds.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/savemxs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/savemxs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" 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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
savemxs <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">name</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">exchange</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">preference</span><span class="token operator">=</span><span class="token string">'20'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b96q:1" aria-labelledby="tab:R99b96q: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: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">"metadata"</span>: <button class="collapser" aria-label="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">"savemxs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Bind reloading on server1 using rndc zone: [example.com]\n"</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/Domain-Management/operation/set_nsec3_for_domains" data-section-id="tag/Domain-Management/operation/set_nsec3_for_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_nsec3_for_domains" id="operation/set_nsec3_for_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Management/operation/set_nsec3_for_domains" aria-label="tag/Domain-Management/operation/set_nsec3_for_domains"></a>Enable NSEC3 semantics for domain<!-- --> </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>Note:</strong></p>
<p>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn&#39;t use PowerDNS, you will receive an error.</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>Note:</strong></p>
<p>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn't use PowerDNS, you will receive an error.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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 enable NSEC3 semantics.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for 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.</p>
<p> <strong>Note</strong></p>
<p>For information about these modes, read <a href="https://doc.powerdns.com/authoritative/dnssec/intro.html">PowerDNS&#39;s DNSSEC documentation</a>.</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 mode or Inclusive mode.</p>
<p> <strong>Note</strong></p>
<p>For information about these modes, read <a href="https://doc.powerdns.com/authoritative/dnssec/intro.html">PowerDNS's DNSSEC documentation</a>.</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><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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 <strong>all</strong> delegations.</p>
<ul>
<li><code>1</code> - Create records for <strong>all</strong> delegations.</li>
<li><code>0</code> - Create records <strong>only</strong> for secure delegations.</li>
</ul>
<p><strong>Note</strong></p>
<p>Only 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 <strong>all</strong> delegations.</p>
<ul>
<li><code>1</code> - Create records for <strong>all</strong> delegations.</li>
<li><code>0</code> - Create records <strong>only</strong> for secure delegations.</li>
</ul>
<p><strong>Note</strong></p>
<p>Only 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></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.</p>
<p> <strong>Note:</strong></p>
<p> For information about salt values, read <a href="https://tools.ietf.org/html/rfc5155#section-3.1.5">RFC 5155</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The salt value that PowerDNS uses in the hashes.</p>
<p> <strong>Note:</strong></p>
<p> For information about salt values, read <a href="https://tools.ietf.org/html/rfc5155#section-3.1.5">RFC 5155</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/set_nsec3_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_nsec3_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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_nsec3_for_domains <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:R99d96q:1" aria-labelledby="tab:R99d96q: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: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">"data"</span>: <button class="collapser" aria-label="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 "><button class="collapser" aria-label="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">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">"Error message."</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">"metadata"</span>: <button class="collapser" aria-label="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">"set_nsec3_for_domains"</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/Domain-Management/operation/unset_nsec3_for_domains" data-section-id="tag/Domain-Management/operation/unset_nsec3_for_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/unset_nsec3_for_domains" id="operation/unset_nsec3_for_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Management/operation/unset_nsec3_for_domains" aria-label="tag/Domain-Management/operation/unset_nsec3_for_domains"></a>Enable NSEC semantics for domain<!-- --> </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 <a href="https://tools.ietf.org/html/rfc4470">Next Secure Record 3</a> (NSEC3) semantics.</p>
<p><strong>Note:</strong></p>
<p>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn&#39;t use PowerDNS, you will receive an error.</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 <a href="https://tools.ietf.org/html/rfc4470">Next Secure Record 3</a> (NSEC3) semantics.</p>
<p><strong>Note:</strong></p>
<p>Only servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn't use PowerDNS, you will receive an error.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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 for which to disable NSEC3 semantics and use NSEC semantics.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/unset_nsec3_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/unset_nsec3_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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
unset_nsec3_for_domains <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:R99f96q:1" aria-labelledby="tab:R99f96q: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: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">"data"</span>: <button class="collapser" aria-label="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 "><button class="collapser" aria-label="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>: <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">"error"</span>: <span class="token string">"Error message."</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">"metadata"</span>: <button class="collapser" aria-label="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">"unset_nsec3_for_domains"</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/Domain-Management/operation/addzonerecord" data-section-id="tag/Domain-Management/operation/addzonerecord" class="sc-dntaoT ceciOs"><div data-section-id="operation/addzonerecord" id="operation/addzonerecord" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Management/operation/addzonerecord" aria-label="tag/Domain-Management/operation/addzonerecord"></a>Create DNS zone record<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds a DNS zone record.</p>
<p><strong>Important:</strong></p>
<ul>
<li>When you call this function, you <strong>must</strong> include the additional parameters for the selected zone record type.</li>
<li>When you disable the <a href="https://go.cpanel.net/serverroles#roles">DNS role</a>, the system <strong>disables</strong> this function.</li>
</ul>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of SPF resource records on DNS.</p>
<ul>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because <a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>. CentOS 7 servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the <a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds a DNS zone record.</p>
<p><strong>Important:</strong></p>
<ul>
<li>When you call this function, you <strong>must</strong> include the additional parameters for the selected zone record type.</li>
<li>When you disable the <a href="https://go.cpanel.net/serverroles#roles">DNS role</a>, the system <strong>disables</strong> this function.</li>
</ul>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of SPF resource records on DNS.</p>
<ul>
<li>This warning is <strong>not</strong> relevant on CentOS 7 servers, because <a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>. CentOS 7 servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the <a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</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><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">application/x-www-form-urlencoded</span></h5><div html="" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"></div><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="class" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand class"><span class="property-name">class</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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><div html="<p>The record&#39;s class.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The record's class.</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><div html="<p>The new zone record&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new zone record's domain.</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"> <!-- --><<!-- -->domain<!-- -->><!-- --> </span></div> <div><div html="<p>The record&#39;s name.</p>
<p><strong>Note:</strong></p>
<p>Do <strong>not</strong> omit any necessary trailing periods.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The record's name.</p>
<p><strong>Note:</strong></p>
<p>Do <strong>not</strong> omit any necessary trailing periods.</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><div html="<p>The <a href="https://en.wikipedia.org/wiki/List_of_DNS_record_types">DNS record type</a>:</p>
<ul>
<li><code>A</code> - A records store IPv4 addresses. Use them to map a hostname to an IPv4 address.</li>
<li><code>A6</code> - A6 records store IPv6 addresses.</li>
<li><code>AAAA</code> - AAAA records store IPv6 addresses.</li>
<li><code>AFSDB</code> - AFSDB records store the location of an AFS cell&#39;s database servers.</li>
<li><code>ALIAS</code> - ALIAS records create an alias to another hostname, but can coexist with other records on that name. We strongly discourage using this record type.</li>
<li><code>CAA</code> - CAA records control which certificate authorities can issue SSL certificates for a domain.</li>
<li><code>CNAME</code> - CNAME records create an alias to another hostname.</li>
<li><code>DNAME</code> - DNAME records create an alias for a hostname and its subnames.</li>
<li><code>DS</code> - DS records specify a record&#39;s delegation signer.</li>
<li><code>HINFO</code> - HINFO records specify a host&#39;s CPU and OS types.</li>
<li><code>LOC</code> - LOC records store a hostname&#39;s geographical location.</li>
<li><code>MX</code> - MX records point a domain name to its MTAs.</li>
<li><code>NS</code> - NS records store a domain&#39;s authoritative nameservers.</li>
<li><code>PTR</code> - PTR records point to a CNAME.</li>
<li><code>RP</code> - RP records store a domain&#39;s Responsible Person&#39;s information.</li>
<li><code>SOA</code> - SOA records designate the beginning of a zone of authority.</li>
<li><code>SRV</code> - SRV records store the service location records for newer protocols (for example, Autodiscover).</li>
<li><code>TXT</code> - TXT records store descriptive text or useful records (for example, SPF or DKIM records).</li>
</ul>
<p>When you call this function, you <strong>must</strong> include the additional parameters for the desired
zone record type. Select a zone record from the menu to view the required additional
parameters:</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://en.wikipedia.org/wiki/List_of_DNS_record_types">DNS record type</a>:</p>
<ul>
<li><code>A</code> - A records store IPv4 addresses. Use them to map a hostname to an IPv4 address.</li>
<li><code>A6</code> - A6 records store IPv6 addresses.</li>
<li><code>AAAA</code> - AAAA records store IPv6 addresses.</li>
<li><code>AFSDB</code> - AFSDB records store the location of an AFS cell's database servers.</li>
<li><code>ALIAS</code> - ALIAS records create an alias to another hostname, but can coexist with other records on that name. We strongly discourage using this record type.</li>
<li><code>CAA</code> - CAA records control which certificate authorities can issue SSL certificates for a domain.</li>
<li><code>CNAME</code> - CNAME records create an alias to another hostname.</li>
<li><code>DNAME</code> - DNAME records create an alias for a hostname and its subnames.</li>
<li><code>DS</code> - DS records specify a record's delegation signer.</li>
<li><code>HINFO</code> - HINFO records specify a host's CPU and OS types.</li>
<li><code>LOC</code> - LOC records store a hostname's geographical location.</li>
<li><code>MX</code> - MX records point a domain name to its MTAs.</li>
<li><code>NS</code> - NS records store a domain's authoritative nameservers.</li>
<li><code>PTR</code> - PTR records point to a CNAME.</li>
<li><code>RP</code> - RP records store a domain's Responsible Person's information.</li>
<li><code>SOA</code> - SOA records designate the beginning of a zone of authority.</li>
<li><code>SRV</code> - SRV records store the service location records for newer protocols (for example, Autodiscover).</li>
<li><code>TXT</code> - TXT records store descriptive text or useful records (for example, SPF or DKIM records).</li>
</ul>
<p>When you call this function, you <strong>must</strong> include the additional parameters for the desired
zone record type. Select a zone record from the menu to view the required additional
parameters:</p>
</div></div><div class="sc-diYFot jsRqjj"><svg class="sc-kZrBCu bweot" 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="PTR (Reverse DNS)">PTR (Reverse DNS)</option><option value="A" selected="">A</option><option value="A6">A6</option><option value="AAAA">AAAA</option><option value="AFSDB">AFSDB</option><option value="ALIAS">ALIAS</option><option value="CAA">CAA</option><option value="CNAME">CNAME</option><option value="DNAME">DNAME</option><option value="DS">DS</option><option value="HINFO">HINFO</option><option value="LOC">LOC</option><option value="MX">MX</option><option value="NS">NS</option><option value="RP">RP</option><option value="SOA">SOA</option><option value="SRV">SRV</option><option value="TXT">TXT</option></select><label>A</label></div></div></td></tr><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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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><div html="<p>The zone record&#39;s IPv4 address.</p>
<p><strong>Note:</strong></p>
<p>For more information about A records, read <a href="http://tools.ietf.org/html/rfc1035">RFC 1035 at IANA</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone record's IPv4 address.</p>
<p><strong>Note:</strong></p>
<p>For more information about A records, read <a href="http://tools.ietf.org/html/rfc1035">RFC 1035 at IANA</a>.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="ttl" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ttl</span></td><td class="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">86400</span></div> <div><div html="<p>The record&#39;s Time To Live (TTL), in seconds.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The record's Time To Live (TTL), in seconds.</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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/addzonerecord</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/addzonerecord</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" 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">HTTP Request (Wire Format)</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">whmapi1 <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>
addzonerecord
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h96q:1" aria-labelledby="tab:R99h96q: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: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">"metadata"</span>: <button class="collapser" aria-label="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">"addzonerecord"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Bind reloading on hostname using rndc zone: [example.com]\n"</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/Domain-Management/operation/resolvedomainname" data-section-id="tag/Domain-Management/operation/resolvedomainname" class="sc-dntaoT ceciOs"><div data-section-id="operation/resolvedomainname" id="operation/resolvedomainname" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Management/operation/resolvedomainname" aria-label="tag/Domain-Management/operation/resolvedomainname"></a>Return domain's IP address<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function resolves a domain&#39;s IPv4 address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function resolves a domain's 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="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.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/resolvedomainname</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/resolvedomainname</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99j96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j96q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j96q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j96q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j96q:0" aria-labelledby="tab:R99j96q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
resolvedomainname <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:R99j96q:1" aria-labelledby="tab:R99j96q: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:R9pj96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj96q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj96q:0" aria-labelledby="tab:R9pj96q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"192.168.0.20"</span></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">"command"</span>: <span class="token string">"resolvedomainname"</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/Domain-Management/operation/listmxs" data-section-id="tag/Domain-Management/operation/listmxs" class="sc-dntaoT ceciOs"><div data-section-id="operation/listmxs" id="operation/listmxs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Management/operation/listmxs" aria-label="tag/Domain-Management/operation/listmxs"></a>Return domain's mail exchanger records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists a domain&#39;s MX records.</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 lists a domain's MX records.</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="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 zone record&#39;s domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The zone record'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/listmxs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/listmxs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99l96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99l96q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99l96q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l96q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99l96q:0" aria-labelledby="tab:R99l96q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
listmxs <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:R99l96q:1" aria-labelledby="tab:R99l96q: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:R9pl96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pl96q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pl96q:0" aria-labelledby="tab:R9pl96q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"record"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"class"</span>: <span class="token string">"IN"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exchange"</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">"name"</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">"preference"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ttl"</span>: <span class="token number">86400</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"MX"</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">"metadata"</span>: <button class="collapser" aria-label="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">"listmxs"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Records obtained."</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/Domain-Management/operation/create_parked_domain_for_user" data-section-id="tag/Domain-Management/operation/create_parked_domain_for_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_parked_domain_for_user" id="operation/create_parked_domain_for_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Management/operation/create_parked_domain_for_user" aria-label="tag/Domain-Management/operation/create_parked_domain_for_user"></a>Create domain alias<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates an alias (parks a domain on a web virtual host).</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates an alias (parks a domain on a web virtual host).</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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=park.example.com</span></div><div><div html="<p>The domain name to park.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain name to park.</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 cPanel user account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel user account.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="web_vhost_domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">web_vhost_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">web_vhost_domain=vhost.example.com</span></div><div><div html="<p>An existing web virtual host to which the new domain name should be added.</p>
<p><strong>Note:</strong></p>
<p> If this is not the cPanel account’s main domain, then the system will consider the new domain to be an <a href="https://go.cpanel.net/cpaneldocsAddonDomains">addon domain</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An existing web virtual host to which the new domain name should be added.</p>
<p><strong>Note:</strong></p>
<p> If this is not the cPanel account’s main domain, then the system will consider the new domain to be an <a href="https://go.cpanel.net/cpaneldocsAddonDomains">addon domain</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="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">/create_parked_domain_for_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/create_parked_domain_for_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:R99n96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99n96q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99n96q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n96q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99n96q:0" aria-labelledby="tab:R99n96q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
create_parked_domain_for_user <span class="token punctuation">\</span>
<span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'park.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">web_vhost_domain</span><span class="token operator">=</span><span class="token string">'vhost.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99n96q:1" aria-labelledby="tab:R99n96q: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:R9pn96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pn96q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pn96q:0" aria-labelledby="tab:R9pn96q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"create_parked_domain_for_user"</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/Domain-Management/operation/create_subdomain" data-section-id="tag/Domain-Management/operation/create_subdomain" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_subdomain" id="operation/create_subdomain" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Management/operation/create_subdomain" aria-label="tag/Domain-Management/operation/create_subdomain"></a>Create subdomain<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates a subdomain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a subdomain.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="document_root" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">document_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">document_root=public_html/directory_name</span></div><div><div html="<p>The subdomain&#39;s document root within the home directory.</p>
<p> <strong>Note:</strong></p>
<ul>
<li>An invalid document root path will cause this function to <strong>fail</strong>.</li>
<li>If the <em>Restrict document roots to public_html</em> value is set to <code>On</code> in WHM&#39;s <a href="https://go.cpanel.net/whmdocsTweakSettings">Tweak Settings</a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>), this parameter <strong>must</strong> begin with the <code>public_html/</code> path. For more information, read the <a href="https://go.cpanel.net/cpanelconfiginvalid">cpanel.config</a> file documentation.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The subdomain's document root within the home directory.</p>
<p> <strong>Note:</strong></p>
<ul>
<li>An invalid document root path will cause this function to <strong>fail</strong>.</li>
<li>If the <em>Restrict document roots to public_html</em> value is set to <code>On</code> in WHM's <a href="https://go.cpanel.net/whmdocsTweakSettings">Tweak Settings</a> interface (<em>WHM >> Home >> Server Configuration >> Tweak Settings</em>), this parameter <strong>must</strong> begin with the <code>public_html/</code> path. For more information, read the <a href="https://go.cpanel.net/cpanelconfiginvalid">cpanel.config</a> file documentation.</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=subdomain.example.com</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="use_canonical_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">use_canonical_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">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">use_canonical_name=0</span></div><div><div html="<p>Whether to use a canonical name 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 canonical name.</li>
<li><code>0</code> — Do <strong>not</strong> use the canonical name.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use a canonical name 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 canonical name.</li>
<li><code>0</code> — Do <strong>not</strong> use the canonical name.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/create_subdomain</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/create_subdomain</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99p96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99p96q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99p96q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99p96q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99p96q:0" aria-labelledby="tab:R99p96q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
create_subdomain <span class="token punctuation">\</span>
<span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'subdomain.example.com'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">document_root</span><span class="token operator">=</span><span class="token string">'public_html/directory_name'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99p96q:1" aria-labelledby="tab:R99p96q: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:R9pp96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pp96q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pp96q:0" aria-labelledby="tab:R9pp96q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"metadata"</span>: <button class="collapser" aria-label="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">"create_subdomain"</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/Domain-Management/operation/updateuserdomains" data-section-id="tag/Domain-Management/operation/updateuserdomains" class="sc-dntaoT ceciOs"><div data-section-id="operation/updateuserdomains" id="operation/updateuserdomains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Management/operation/updateuserdomains" aria-label="tag/Domain-Management/operation/updateuserdomains"></a>Update /etc/userdomains file<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function updates the <code>/etc/userdomains</code> file based on the entries in <code>/var/cpanel/users</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates the <code>/etc/userdomains</code> file based on the entries in <code>/var/cpanel/users</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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/updateuserdomains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/updateuserdomains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99r96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99r96q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99r96q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99r96q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99r96q:0" aria-labelledby="tab:R99r96q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
updateuserdomains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99r96q:1" aria-labelledby="tab:R99r96q: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:R9pr96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pr96q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pr96q:0" aria-labelledby="tab:R9pr96q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"updateuserdomains"</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/Domain-Management/operation/delete_domain" data-section-id="tag/Domain-Management/operation/delete_domain" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_domain" id="operation/delete_domain" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Management/operation/delete_domain" aria-label="tag/Domain-Management/operation/delete_domain"></a>Delete domain<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deletes a domain.</p>
<p><strong>Note:</strong></p>
<p>This function does <strong>not</strong> remove an addon domain&#39;s associated subdomain. You <strong>must</strong> also run this function for the associated subdomain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a domain.</p>
<p><strong>Note:</strong></p>
<p>This function does <strong>not</strong> remove an addon domain's associated subdomain. You <strong>must</strong> also run this function for the associated subdomain.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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 name of the domain to delete.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the domain 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/delete_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/delete_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:R99t96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99t96q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99t96q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99t96q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99t96q:0" aria-labelledby="tab:R99t96q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
delete_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:R99t96q:1" aria-labelledby="tab:R99t96q: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:R9pt96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pt96q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pt96q:0" aria-labelledby="tab:R9pt96q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"addon"</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="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">"delete_domain"</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/Resolvers" data-section-id="tag/Resolvers" 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/Resolvers" aria-label="tag/Resolvers"></a>Resolvers</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>DNS / Resolvers</p>
"><p>DNS / Resolvers</p>
</div></div></div><div id="tag/Resolvers/operation/DNS::is_alias_available" data-section-id="tag/Resolvers/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/Resolvers/operation/DNS::is_alias_available" aria-label="tag/Resolvers/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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
is_alias_available
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjb6q:1" aria-labelledby="tab:R4kjb6q: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: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">"data"</span>: <button class="collapser" aria-label="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">"metadata"</span>: <button class="collapser" aria-label="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">"is_alias_available"</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/Resolvers/operation/set_up_dns_resolver_workarounds" data-section-id="tag/Resolvers/operation/set_up_dns_resolver_workarounds" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_up_dns_resolver_workarounds" id="operation/set_up_dns_resolver_workarounds" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Resolvers/operation/set_up_dns_resolver_workarounds" aria-label="tag/Resolvers/operation/set_up_dns_resolver_workarounds"></a>Create unbound DNS resolver<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates an <a href="http://www.linuxfromscratch.org/blfs/view/svn/server/unbound.html">Unbound</a> (<code>libunbound</code>) DNS resolver configuration.</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 creates an <a href="http://www.linuxfromscratch.org/blfs/view/svn/server/unbound.html">Unbound</a> (<code>libunbound</code>) DNS resolver configuration.</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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/set_up_dns_resolver_workarounds</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_up_dns_resolver_workarounds</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" 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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_up_dns_resolver_workarounds
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4klb6q:1" aria-labelledby="tab:R4klb6q: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: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">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"flags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"do-ip6"</span>: <span class="token string">"no"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"do-udp"</span>: <span class="token string">"no"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edns-buffer-size"</span>: <span class="token string">"512"</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"set_up_dns_resolver_workarounds"</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/Resolvers/operation/get_nameserver_config" data-section-id="tag/Resolvers/operation/get_nameserver_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_nameserver_config" id="operation/get_nameserver_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Resolvers/operation/get_nameserver_config" aria-label="tag/Resolvers/operation/get_nameserver_config"></a>Return current user's nameservers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the default nameservers for the currently-authenticated user.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the default nameservers for the currently-authenticated 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_nameserver_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_nameserver_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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_nameserver_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knb6q:1" aria-labelledby="tab:R4knb6q: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: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">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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></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">"command"</span>: <span class="token string">"get_nameserver_config"</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/Resolvers/operation/lookupnsip" data-section-id="tag/Resolvers/operation/lookupnsip" class="sc-dntaoT ceciOs"><div data-section-id="operation/lookupnsip" id="operation/lookupnsip" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Resolvers/operation/lookupnsip" aria-label="tag/Resolvers/operation/lookupnsip"></a>Return nameserver's IP address<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves a nameserver&#39;s IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a nameserver's 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="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><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">host=ns1.example.com</span></div><div><div html="<p>The nameserver&#39;s hostname.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The nameserver's 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/lookupnsip</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/lookupnsip</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" 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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
lookupnsip <span class="token punctuation">\</span>
<span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'ns1.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kpb6q:1" aria-labelledby="tab:R4kpb6q: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: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">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"192.168.0.20"</span></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">"command"</span>: <span class="token string">"lookupnsip"</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/Resolvers/operation/lookupnsips" data-section-id="tag/Resolvers/operation/lookupnsips" class="sc-dntaoT ceciOs"><div data-section-id="operation/lookupnsips" id="operation/lookupnsips" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Resolvers/operation/lookupnsips" aria-label="tag/Resolvers/operation/lookupnsips"></a>Return nameserver's IPv4 and IPv6 addresses<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves a nameserver&#39;s IPv4 and IPv6 addresses.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a nameserver's IPv4 and IPv6 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="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=ns1.example.com</span></div><div><div html="<p>The nameserver&#39;s hostname.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The nameserver's 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/lookupnsips</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/lookupnsips</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4krb6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4krb6q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4krb6q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4krb6q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4krb6q:0" aria-labelledby="tab:R4krb6q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
lookupnsips <span class="token punctuation">\</span>
<span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'ns1.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4krb6q:1" aria-labelledby="tab:R4krb6q: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:R4srb6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4srb6q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4srb6q:0" aria-labelledby="tab:R4srb6q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ipv4"</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">"ipv6"</span>: <span class="token string">"2001:0db8:0:0:1: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">"metadata"</span>: <button class="collapser" aria-label="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">"lookupnsips"</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/Resolvers/operation/setresolvers" data-section-id="tag/Resolvers/operation/setresolvers" class="sc-dntaoT ceciOs"><div data-section-id="operation/setresolvers" id="operation/setresolvers" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Resolvers/operation/setresolvers" aria-label="tag/Resolvers/operation/setresolvers"></a>Update server's resolver nameservers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function configures the server&#39;s resolver nameservers.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>The nameservers that the server uses as resolvers <strong>must</strong> function correctly. If they do not, the server will experience performance and stability issues.</li>
<li><strong>Never</strong> set a resolver nameserver to <code>127.0.0.1</code> on a cPanel &amp; WHM server.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function configures the server's resolver nameservers.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>The nameservers that the server uses as resolvers <strong>must</strong> function correctly. If they do not, the server will experience performance and stability issues.</li>
<li><strong>Never</strong> set a resolver nameserver to <code>127.0.0.1</code> on a cPanel & WHM 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="nameserver1" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand nameserver1"><span class="property-name">nameserver1</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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">nameserver1=192.168.0.20</span></div><div><div html="<p>The server&#39;s primary resolver nameserver.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server's primary resolver nameserver.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="nameserver2" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand nameserver2"><span class="property-name">nameserver2</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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><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">nameserver2=192.168.0.21</span></div><div><div html="<p>The server&#39;s secondary resolver nameserver.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server's secondary resolver nameserver.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="nameserver3" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand nameserver3"><span class="property-name">nameserver3</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">nameserver3=2001:4860:4860::8888</span></div><div><div html="<p>The server&#39;s tertiary resolver nameserver.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server's tertiary resolver nameserver.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/setresolvers</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/setresolvers</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4ktb6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4ktb6q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4ktb6q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4ktb6q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4ktb6q:0" aria-labelledby="tab:R4ktb6q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
setresolvers <span class="token punctuation">\</span>
<span class="token assign-left variable">nameserver1</span><span class="token operator">=</span><span class="token string">'192.168.0.20'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">nameserver2</span><span class="token operator">=</span><span class="token string">'192.168.0.21'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4ktb6q:1" aria-labelledby="tab:R4ktb6q: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:R4stb6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4stb6q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4stb6q:0" aria-labelledby="tab:R4stb6q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"setresolvers"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token string">"Listed in order they are:\n192.168.0.20\n192.168.0.21\n2001:4860:4860::8888\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">"reason"</span>: <span class="token string">"Your resolvers have been setup!"</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/Resolvers/operation/update_nameservers_config" data-section-id="tag/Resolvers/operation/update_nameservers_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/update_nameservers_config" id="operation/update_nameservers_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Resolvers/operation/update_nameservers_config" aria-label="tag/Resolvers/operation/update_nameservers_config"></a>Update default nameservers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function updates nameservers in the <code>wwwacct.conf</code> file. For more information, read our <a href="https://go.cpanel.net/advancedinstall">Installation Guide - Customize Your Installation</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates nameservers in the <code>wwwacct.conf</code> file. For more information, read our <a href="https://go.cpanel.net/advancedinstall">Installation Guide - Customize Your Installation</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="nameserver" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nameserver</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">nameserver=ns1.example.com</span></div><div><div html="<p>The nameserver to add or update as the <code>wwwacct.conf</code> file&#39;s <code>NS</code> setting. If you do not supply a value, the function does not update the setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The nameserver to add or update as the <code>wwwacct.conf</code> file's <code>NS</code> setting. If you do not supply a value, the function does not update the setting.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="nameserver2" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nameserver2</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">nameserver2=ns2.example.com</span></div><div><div html="<p>The nameserver to add or update as the <code>wwwacct.conf</code> file&#39;s <code>NS2</code> setting. If you do not supply a value, the function does not update the setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The nameserver to add or update as the <code>wwwacct.conf</code> file's <code>NS2</code> setting. If you do not supply a value, the function does not update the setting.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="nameserver3" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nameserver3</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">nameserver3=ns3.example.com</span></div><div><div html="<p>The nameserver to add or update as the <code>wwwacct.conf</code> file&#39;s <code>NS3</code> setting. If you do not supply a value, the function does not update the setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The nameserver to add or update as the <code>wwwacct.conf</code> file's <code>NS3</code> setting. If you do not supply a value, the function does not update the setting.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="nameserver4" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nameserver4</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">nameserver4=ns4.example.com</span></div><div><div html="<p>The nameserver to add or update as the <code>wwwacct.conf</code> file&#39;s <code>NS4</code> setting. If you do not supply a value, the function does not update the setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The nameserver to add or update as the <code>wwwacct.conf</code> file's <code>NS4</code> setting. If you do not supply a value, the function does not update the setting.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/update_nameservers_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/update_nameservers_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:R4kvb6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kvb6q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kvb6q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kvb6q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kvb6q:0" aria-labelledby="tab:R4kvb6q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
update_nameservers_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kvb6q:1" aria-labelledby="tab:R4kvb6q: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:R4svb6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4svb6q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4svb6q:0" aria-labelledby="tab:R4svb6q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"update_nameservers_config"</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/Feature-Access" data-section-id="tag/Feature-Access" 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/Feature-Access" aria-label="tag/Feature-Access"></a>Feature Access</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Hosting Plans / Feature Access</p>
"><p>Hosting Plans / Feature Access</p>
</div></div></div><div id="tag/Feature-Access/operation/verify_user_has_feature" data-section-id="tag/Feature-Access/operation/verify_user_has_feature" class="sc-dntaoT ceciOs"><div data-section-id="operation/verify_user_has_feature" id="operation/verify_user_has_feature" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Feature-Access/operation/verify_user_has_feature" aria-label="tag/Feature-Access/operation/verify_user_has_feature"></a>Return cPanel account feature access<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks whether a user has access to a feature on a <a href="https://go.cpanel.net/whmdocsFeatureManager">feature list</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether a user has access to a feature on a <a href="https://go.cpanel.net/whmdocsFeatureManager">feature list</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="feature" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">feature</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">feature=sslinstall</span></div><div><div html="<p>The feature&#39;s ID.</p>
<p><strong>Note:</strong></p>
<p>Call WHM API 1&#39;s <code>get_feature_names</code> function to view available features.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The feature's ID.</p>
<p><strong>Note:</strong></p>
<p>Call WHM API 1's <code>get_feature_names</code> function to view available features.</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=username</span></div><div><div html="<p>The cPanel account username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/verify_user_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/verify_user_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:R4kj37a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj37a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj37a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj37a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj37a:0" aria-labelledby="tab:R4kj37a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
verify_user_has_feature <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">feature</span><span class="token operator">=</span><span class="token string">'sslinstall'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj37a:1" aria-labelledby="tab:R4kj37a: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:R4sj37a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj37a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj37a:0" aria-labelledby="tab:R4sj37a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_feature"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"query_feature"</span>: <span class="token string">"sslinstall"</span></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">"command"</span>: <span class="token string">"verify_user_has_feature"</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/Feature-Access/operation/remove_override_features_for_user" data-section-id="tag/Feature-Access/operation/remove_override_features_for_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/remove_override_features_for_user" id="operation/remove_override_features_for_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Feature-Access/operation/remove_override_features_for_user" aria-label="tag/Feature-Access/operation/remove_override_features_for_user"></a>Remove cPanel account feature list overrides<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes feature overrides from a cPanel account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes feature overrides 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=""><td kind="field" title="features" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">features</span><div class="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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">features=["sslinstall","videotut"]</span></div><div><div html="<p>An array that contains the features&#39; names.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Call WHM API 1&#39;s <code>get_feature_names</code> function to view available features.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An array that contains the features' names.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Call WHM API 1's <code>get_feature_names</code> function to view available features.</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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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 user&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user'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="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">/remove_override_features_for_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remove_override_features_for_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:R4kl37a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl37a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl37a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl37a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl37a:0" aria-labelledby="tab:R4kl37a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remove_override_features_for_user <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">features</span><span class="token operator">=</span><span class="token string">'["sslinstall","videotut"]'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl37a:1" aria-labelledby="tab:R4kl37a: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:R4sl37a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl37a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl37a:0" aria-labelledby="tab:R4sl37a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"remove_override_features_for_user"</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/Feature-Access/operation/get_users_features_settings" data-section-id="tag/Feature-Access/operation/get_users_features_settings" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_users_features_settings" id="operation/get_users_features_settings" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Feature-Access/operation/get_users_features_settings" aria-label="tag/Feature-Access/operation/get_users_features_settings"></a>Return cPanel accounts' feature settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the features settings of cPanel accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the features settings of 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><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="feature" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">feature</span></td><td class="sc-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">feature=feature-1=autossl feature-2=addoncgi feature-3=addondomains</span> -<!-- --> <!-- -->Multiple feature.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">feature=autossl</span> -<!-- --> <!-- -->A single feature.</li></ul><div><div html="<p>The feature&#39;s name.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To check multiple features, increment the parameter name. For example, <code>feature-1</code>, <code>feature-2</code>, and <code>feature-3</code>.</li>
<li>If you use this parameter, you <strong>must</strong> enter a feature name, or the function returns an error. If you do <strong>not</strong> use this parameter, the function returns data for all features on the server.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The feature's name.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To check multiple features, increment the parameter name. For example, <code>feature-1</code>, <code>feature-2</code>, and <code>feature-3</code>.</li>
<li>If you use this parameter, you <strong>must</strong> enter a feature name, or the function returns an error. If you do <strong>not</strong> use this parameter, the function returns data for all features on the server.</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> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=user-1=example1 user-2=example2 user-3=example3</span> -<!-- --> <!-- -->Multiple users.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=example</span> -<!-- --> <!-- -->A single user.</li></ul><div><div html="<p>The user&#39;s username.</p>
<p><strong>Note:</strong></p>
<p>To check multiple users, increment the parameter name. For example, <code>user-1</code>, <code>user-2</code>, and <code>user-3</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user's username.</p>
<p><strong>Note:</strong></p>
<p>To check multiple users, increment the parameter name. For example, <code>user-1</code>, <code>user-2</code>, and <code>user-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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_users_features_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_users_features_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:R4kn37a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn37a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn37a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn37a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn37a:0" aria-labelledby="tab:R4kn37a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_users_features_settings <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R4kn37a:1" aria-labelledby="tab:R4kn37a: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:R4sn37a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn37a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn37a:0" aria-labelledby="tab:R4sn37a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"users_features_settings"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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_setting"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature"</span>: <span class="token string">"autossl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature_list"</span>: <span class="token string">"autossl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature_list_setting"</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">"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">"metadata"</span>: <button class="collapser" aria-label="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">"get_users_features_settings"</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/Feature-Access/operation/add_override_features_for_user" data-section-id="tag/Feature-Access/operation/add_override_features_for_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_override_features_for_user" id="operation/add_override_features_for_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Feature-Access/operation/add_override_features_for_user" aria-label="tag/Feature-Access/operation/add_override_features_for_user"></a>Add cPanel account feature list overrides<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds feature overrides to a cPanel account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds feature overrides to 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="features" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand features"><span class="property-name">features</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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">features={"backup":1}</span></div><div><div html="<p>A JSON-encoded list of features to override and whether to enable or disable them.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A JSON-encoded list of features to override and whether to enable or disable them.</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=username</span></div><div><div html="<p>The cPanel username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="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">/add_override_features_for_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/add_override_features_for_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:R4kp37a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp37a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp37a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp37a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp37a:0" aria-labelledby="tab:R4kp37a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
add_override_features_for_user <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">features</span><span class="token operator">=</span><span class="token string">'{"backup":"1"}'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp37a:1" aria-labelledby="tab:R4kp37a: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:R4sp37a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp37a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp37a:0" aria-labelledby="tab:R4sp37a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"add_override_features_for_user"</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/Feature-Lists" data-section-id="tag/Feature-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/Feature-Lists" aria-label="tag/Feature-Lists"></a>Feature Lists</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Hosting Plans / Feature Lists</p>
"><p>Hosting Plans / Feature Lists</p>
</div></div></div><div id="tag/Feature-Lists/operation/get_available_applications" data-section-id="tag/Feature-Lists/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/Feature-Lists/operation/get_available_applications" aria-label="tag/Feature-Lists/operation/get_available_applications"></a>Return dynamicui file<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the contents of a <code>dynamicui</code> file. For more
information, read our
<a href="https://go.cpanel.net/GuidetoWHMdynamicuiFiles">Guide to WHM dynamicui Files</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the contents of a <code>dynamicui</code> file. For more
information, read our
<a href="https://go.cpanel.net/GuidetoWHMdynamicuiFiles">Guide to WHM dynamicui Files</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="applications_list" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">applications_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">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">applications_list=create_support_ticket</span></div><div><div html="<p>A comma-separated list of the application entries to return.</p>
<p>To determine the application&#39;s name, find its
<a href="https://go.cpanel.net/GuidetoWHMdynamicuiFiles"><code>file</code> value in the <code>dynamicui.conf</code> file</a>,
and then remove the file extension.</p>
<p>If you do not specify this value, the function returns the entire <code>dynamicui.conf</code>
file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of the application entries to return.</p>
<p>To determine the application's name, find its
<a href="https://go.cpanel.net/GuidetoWHMdynamicuiFiles"><code>file</code> value in the <code>dynamicui.conf</code> file</a>,
and then remove the file extension.</p>
<p>If you do not specify this value, the function returns the entire <code>dynamicui.conf</code>
file.</p>
</div></div></div></td></tr><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></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"dynamicui.conf"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">file=dynamicui.conf</span></div><div><div html="<p>The <code>dynamicui</code> configuration file to retrieve, relative to the <code>/usr/local/cpanel/whostmgr/docroot/themes/x/</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <code>dynamicui</code> configuration file to retrieve, relative to the <code>/usr/local/cpanel/whostmgr/docroot/themes/x/</code> 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99357a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99357a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99357a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99357a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99357a:0" aria-labelledby="tab:R99357a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_available_applications
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99357a:1" aria-labelledby="tab:R99357a: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:R9p357a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p357a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p357a:0" aria-labelledby="tab:R9p357a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"acl"</span>: <span class="token string">"ACL=all"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dnsonly_ok"</span>: <span class="token string">"dns"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">"feature_name.png"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"group_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"groupdesc"</span>: <span class="token string">"$LANG{'Group Name'}"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"grouporder"</span>: <span class="token number">1</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">"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">"acl"</span>: <span class="token string">"ACL=all"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"View and manage reseller accounts on your server. Resellers manage other [asis,cPanel] accounts and can access [asis,cPanel]."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dnsonly_ok"</span>: <span class="token string">"dns"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">"feature_name.png"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"group_name"</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">"$LANG{'Feature Name'}"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemorder"</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">"feature_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"minimum_accounts_needed"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"multiuser_required"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <button class="collapser" aria-label="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">"any"</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">"MailLocal"</span>,</div></li><li><div class="hoverable "><span class="token string">"MailSend"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchtext"</span>: <span class="token string">"search keywords"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"mysql"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subitems"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acl"</span>: <span class="token string">"ACL=all"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"breadcrumb"</span>: <span class="token string">"/example_plugin/feature_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dnsonly_ok"</span>: <span class="token string">"dns"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">"feature_name.png"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">"group_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemdesc"</span>: <span class="token string">"$LANG{'Feature Name'}"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"feature_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchtext"</span>: <span class="token string">"search keywords"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">"_blank"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"subitem"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"/example_plugin/feature_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">"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">"_blank"</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">"/example_plugin/feature_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">"key"</span>: <span class="token string">"feature_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchtext"</span>: <span class="token string">"search keywords"</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">"_blank"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"group"</span></div></li></ul><span class="token punctuation">}</span></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"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"itemdesc"</span>: <span class="token string">"[% PROCESS 'menu/plugins_list.tmpl' target='mainFrame' -%]"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"raw"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_available_applications"</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/Feature-Lists/operation/create_featurelist" data-section-id="tag/Feature-Lists/operation/create_featurelist" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_featurelist" id="operation/create_featurelist" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Feature-Lists/operation/create_featurelist" aria-label="tag/Feature-Lists/operation/create_featurelist"></a>Create feature list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates or updates a feature list.</p>
<p><strong>Note:</strong></p>
<p>A reseller <strong>must</strong> possess the
<a href="https://docs.cpanel.net/whm/resellers/edit-reseller-nameservers-and-privileges/#packages">Add/Remove Package feature</a>
to use this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates or updates a feature list.</p>
<p><strong>Note:</strong></p>
<p>A reseller <strong>must</strong> possess the
<a href="https://docs.cpanel.net/whm/resellers/edit-reseller-nameservers-and-privileges/#packages">Add/Remove Package feature</a>
to use this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="featurelist" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">featurelist</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">featurelist=CustomFeatureList</span></div><div><div html="<p>The feature list&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The feature list's name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="featurelistname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">featurelistname</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">featurelistname=1</span></div><div><div html="<p>Whether to add a specific feature in the feature list.</p>
<ul>
<li><code>1</code> — Add the feature.</li>
<li><code>0</code> — Do <strong>not</strong> add the feature.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li><p>The parameter&#39;s name is a feature&#39;s name. For example, the <code>changemx=1</code>
adds the <em>Change Mail Exchanger</em> feature to the feature list.</p>
</li>
<li><p>You can add or omit multiple features.</p>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to add a specific feature in the feature list.</p>
<ul>
<li><code>1</code> — Add the feature.</li>
<li><code>0</code> — Do <strong>not</strong> add the feature.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li><p>The parameter's name is a feature's name. For example, the <code>changemx=1</code>
adds the <em>Change Mail Exchanger</em> feature to the feature list.</p>
</li>
<li><p>You can add or omit multiple features.</p>
</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="overwrite" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">overwrite</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">overwrite=1</span></div><div><div html="<p>Whether to overwrite an existing feature list.</p>
<ul>
<li><code>1</code> — Overwrite.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to overwrite an existing feature list.</p>
<ul>
<li><code>1</code> — Overwrite.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/create_featurelist</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/create_featurelist</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99557a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99557a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99557a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99557a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99557a:0" aria-labelledby="tab:R99557a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
create_featurelist <span class="token punctuation">\</span>
<span class="token assign-left variable">featurelist</span><span class="token operator">=</span>Arthur <span class="token assign-left variable">webmail</span><span class="token operator">=</span><span class="token number">1</span> <span class="token assign-left variable">changemx</span><span class="token operator">=</span><span class="token number">1</span> <span class="token assign-left variable">overwrite</span><span class="token operator">=</span><span class="token number">1</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99557a:1" aria-labelledby="tab:R99557a: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:R9p557a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p557a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p557a:0" aria-labelledby="tab:R9p557a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"featurelist"</span>: <span class="token string">"Arthur"</span></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">"command"</span>: <span class="token string">"create_featurelist"</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/Feature-Lists/operation/delete_featurelist" data-section-id="tag/Feature-Lists/operation/delete_featurelist" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_featurelist" id="operation/delete_featurelist" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Feature-Lists/operation/delete_featurelist" aria-label="tag/Feature-Lists/operation/delete_featurelist"></a>Delete feature list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deletes a feature list.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a feature list.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="featurelist" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">featurelist</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">featurelist=TestList</span></div><div><div html="<p>The feature list&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The feature list'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/delete_featurelist</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/delete_featurelist</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99757a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99757a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99757a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99757a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99757a:0" aria-labelledby="tab:R99757a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
delete_featurelist <span class="token punctuation">\</span>
<span class="token assign-left variable">featurelist</span><span class="token operator">=</span><span class="token string">'TestList'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99757a:1" aria-labelledby="tab:R99757a: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:R9p757a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p757a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p757a:0" aria-labelledby="tab:R9p757a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_featurelist"</span>: <span class="token string">"TestList"</span></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">"command"</span>: <span class="token string">"delete_featurelist"</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/Feature-Lists/operation/get_feature_metadata" data-section-id="tag/Feature-Lists/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/Feature-Lists/operation/get_feature_metadata" aria-label="tag/Feature-Lists/operation/get_feature_metadata"></a>Return current user's available feature lists info<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the details of the authenticated user&#39;s available feature lists.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the details of the authenticated user'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99957a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99957a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99957a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99957a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99957a:0" aria-labelledby="tab:R99957a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_feature_metadata
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99957a:1" aria-labelledby="tab:R99957a: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:R9p957a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p957a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p957a:0" aria-labelledby="tab:R9p957a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 "><button class="collapser" aria-label="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">"addondomains"</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">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Addon Domain Manager"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_feature_metadata"</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/Feature-Lists/operation/get_feature_names" data-section-id="tag/Feature-Lists/operation/get_feature_names" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_feature_names" id="operation/get_feature_names" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Feature-Lists/operation/get_feature_names" aria-label="tag/Feature-Lists/operation/get_feature_names"></a>Return all features<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists all available features.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all available 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_feature_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_feature_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:R99b57a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b57a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b57a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b57a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b57a:0" aria-labelledby="tab:R99b57a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_feature_names
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b57a:1" aria-labelledby="tab:R99b57a: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:R9pb57a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb57a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb57a:0" aria-labelledby="tab:R9pb57a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"sslmanager"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"SSL Manager"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_feature_names"</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/Feature-Lists/operation/get_featurelists" data-section-id="tag/Feature-Lists/operation/get_featurelists" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_featurelists" id="operation/get_featurelists" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Feature-Lists/operation/get_featurelists" aria-label="tag/Feature-Lists/operation/get_featurelists"></a>Return current user's available feature lists<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the authenticated user&#39;s available feature lists.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>When you call this function with the <code>root</code> account, it returns <strong>all</strong> feature lists on the server.</li>
<li>When you call this function with a reseller account, it <strong>only</strong> returns feature lists that the account owns.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the authenticated user's available feature lists.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>When you call this function with the <code>root</code> account, it returns <strong>all</strong> feature lists on the server.</li>
<li>When you call this function with a reseller account, it <strong>only</strong> returns feature lists that the account owns.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_featurelists</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_featurelists</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d57a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d57a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d57a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d57a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d57a:0" aria-labelledby="tab:R99d57a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_featurelists
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d57a:1" aria-labelledby="tab:R99d57a: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:R9pd57a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd57a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd57a:0" aria-labelledby="tab:R9pd57a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"featurelists"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"default"</span>,</div></li><li><div class="hoverable "><span class="token string">"disabled"</span>,</div></li><li><div class="hoverable "><span class="token string">"reseller1_test1"</span>,</div></li><li><div class="hoverable "><span class="token string">"reseller1_test2"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"get_featurelists"</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/Feature-Lists/operation/get_featurelist_data" data-section-id="tag/Feature-Lists/operation/get_featurelist_data" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_featurelist_data" id="operation/get_featurelist_data" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Feature-Lists/operation/get_featurelist_data" aria-label="tag/Feature-Lists/operation/get_featurelist_data"></a>Return feature list configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists features in a specific feature list.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists features in a specific feature list.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="featurelist" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">featurelist</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">featurelist="Mail Only"</span></div><div><div html="<p>The feature list for which to list information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The feature list for which to list 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_featurelist_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_featurelist_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:R99f57a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f57a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f57a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f57a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f57a:0" aria-labelledby="tab:R99f57a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_featurelist_data <span class="token punctuation">\</span>
<span class="token assign-left variable">featurelist</span><span class="token operator">=</span><span class="token string">'"Mail Only"'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f57a:1" aria-labelledby="tab:R99f57a: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:R9pf57a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf57a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf57a:0" aria-labelledby="tab:R9pf57a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"featurelist"</span>: <span class="token string">"Mail Only"</span><span class="token punctuation">,</span></div></li><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 "><button class="collapser" aria-label="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">"email_trace"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_disabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_featurelist_data"</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/Feature-Lists/operation/update_featurelist" data-section-id="tag/Feature-Lists/operation/update_featurelist" class="sc-dntaoT ceciOs"><div data-section-id="operation/update_featurelist" id="operation/update_featurelist" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Feature-Lists/operation/update_featurelist" aria-label="tag/Feature-Lists/operation/update_featurelist"></a>Update feature list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates or updates a feature list.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates or updates a feature list.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="feature name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">feature 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">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">feature name=1</span></div><div><div html="<p>Whether to include the feature in the feature list.</p>
<p><strong>Notes:</strong></p>
<p> This parameter&#39;s name is the feature&#39;s name. If you do not specify any features, the system will disable all features in the feature list.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to include the feature in the feature list.</p>
<p><strong>Notes:</strong></p>
<p> This parameter's name is the feature's name. If you do not specify any features, the system will disable all features in the feature list.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="featurelist" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">featurelist</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">featurelist=TheBlackLagoon</span></div><div><div html="<p>The feature list&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The feature list'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/update_featurelist</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/update_featurelist</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99h57a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h57a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h57a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h57a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h57a:0" aria-labelledby="tab:R99h57a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
update_featurelist <span class="token punctuation">\</span>
<span class="token assign-left variable">featurelist</span><span class="token operator">=</span><span class="token string">'TheBlackLagoon'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h57a:1" aria-labelledby="tab:R99h57a: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:R9ph57a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph57a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph57a:0" aria-labelledby="tab:R9ph57a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"featurelist"</span>: <span class="token string">"TheBlackLagoon"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invalid_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 "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"invalid feature"</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">"updated_features"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"autoresponders"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature name"</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">"metadata"</span>: <button class="collapser" aria-label="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">"update_featurelist"</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/Hosting-Plan-Extensions" data-section-id="tag/Hosting-Plan-Extensions" 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/Hosting-Plan-Extensions" aria-label="tag/Hosting-Plan-Extensions"></a>Hosting Plan Extensions</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Hosting Plans / Hosting Plan Extensions</p>
"><p>Hosting Plans / Hosting Plan Extensions</p>
</div></div></div><div id="tag/Hosting-Plan-Extensions/operation/addpkgext" data-section-id="tag/Hosting-Plan-Extensions/operation/addpkgext" class="sc-dntaoT ceciOs"><div data-section-id="operation/addpkgext" id="operation/addpkgext" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Hosting-Plan-Extensions/operation/addpkgext" aria-label="tag/Hosting-Plan-Extensions/operation/addpkgext"></a>Add hosting plan extension<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds a package extension to a hosting plan (package).</p>
<p><strong>Notes:</strong></p>
<ul>
<li><p>If you need to edit a package extension&#39;s parameters, call this function again
with the same package extension name and the updated package extension variables.</p>
</li>
<li><p>You can include the extension&#39;s variables in your function call, in <code>key=value</code> format.
Consult the extension&#39;s documentation for a list of possible variables. Extension variables
are case-sensitive.</p>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds a package extension to a hosting plan (package).</p>
<p><strong>Notes:</strong></p>
<ul>
<li><p>If you need to edit a package extension's parameters, call this function again
with the same package extension name and the updated package extension variables.</p>
</li>
<li><p>You can include the extension's variables in your function call, in <code>key=value</code> format.
Consult the extension's documentation for a list of possible variables. Extension variables
are case-sensitive.</p>
</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="_PACKAGE_EXTENSIONS" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">_PACKAGE_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"></span> -<!-- --> <!-- -->Add multiple package extensions.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl"></span> -<!-- --> <!-- -->Add a single package extension.</li></ul><div><div html="<p>The hosting plan&#39;s
<a href="https://go.cpanel.net/GuidetoPackageExtensions">package extensions</a>.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Use space-delimited format to add multiple package extensions.</li>
<li>Extension names are case-sensitive.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's
<a href="https://go.cpanel.net/GuidetoPackageExtensions">package extensions</a>.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Use space-delimited format to add multiple package extensions.</li>
<li>Extension names are case-sensitive.</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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=package1</span></div><div><div html="<p>The hosting plan&#39;s name.</p>
<p><strong>Note:</strong></p>
<p>You <strong>cannot</strong> use the <code>extensions</code> name for a hosting plan.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's name.</p>
<p><strong>Note:</strong></p>
<p>You <strong>cannot</strong> use the <code>extensions</code> name for a hosting plan.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/addpkgext</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/addpkgext</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab77a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab77a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab77a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab77a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab77a:0" aria-labelledby="tab:R2ab77a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
addpkgext <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'package1'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">_PACKAGE_EXTENSIONS</span><span class="token operator">=</span><span class="token string">'extension1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab77a:1" aria-labelledby="tab:R2ab77a: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:R2eb77a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb77a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb77a:0" aria-labelledby="tab:R2eb77a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"pkg"</span>: <span class="token string">"package1"</span></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">"command"</span>: <span class="token string">"addpkgext"</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/Hosting-Plan-Extensions/operation/delpkgext" data-section-id="tag/Hosting-Plan-Extensions/operation/delpkgext" class="sc-dntaoT ceciOs"><div data-section-id="operation/delpkgext" id="operation/delpkgext" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Hosting-Plan-Extensions/operation/delpkgext" aria-label="tag/Hosting-Plan-Extensions/operation/delpkgext"></a>Remove hosting plan extension<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deletes a package extension from a hosting plan (package).</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can additionally include extension&#39;s variables in your function call, in <code>key=value</code> format.
Consult the extension&#39;s documentation for a list of possible variables. Extension variable names are case-sensitive.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a package extension from a hosting plan (package).</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can additionally include extension's variables in your function call, in <code>key=value</code> format.
Consult the extension's documentation for a list of possible variables. Extension variable names are case-sensitive.</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="_DELETE_EXTENSIONS" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">_DELETE_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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl"></span></div><div><div html="<p>The space delimited
<a href="https://go.cpanel.net/GuidetoPackageExtensions">package extensions</a>
to delete.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Extension names are case-sensitive.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The space delimited
<a href="https://go.cpanel.net/GuidetoPackageExtensions">package extensions</a>
to delete.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Extension names are case-sensitive.</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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=package1</span></div><div><div html="<p>The hosting plan&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/delpkgext</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/delpkgext</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ad77a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad77a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad77a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad77a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad77a:0" aria-labelledby="tab:R2ad77a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
delpkgext <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'package1'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">_DELETE_EXTENSIONS</span><span class="token operator">=</span><span class="token string">'extension1 extension2'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad77a:1" aria-labelledby="tab:R2ad77a: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:R2ed77a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed77a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed77a:0" aria-labelledby="tab:R2ed77a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"pkg"</span>: <span class="token string">"package1"</span></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">"command"</span>: <span class="token string">"delpkgext"</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/Hosting-Plan-Extensions/operation/_getpkgextensionform" data-section-id="tag/Hosting-Plan-Extensions/operation/_getpkgextensionform" class="sc-dntaoT ceciOs"><div data-section-id="operation/_getpkgextensionform" id="operation/_getpkgextensionform" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Hosting-Plan-Extensions/operation/_getpkgextensionform" aria-label="tag/Hosting-Plan-Extensions/operation/_getpkgextensionform"></a>Return hosting plan extension templates<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves a hosting plan&#39;s package extension templates. When you call this
function, the system checks the hosting plan&#39;s <code>_PACKAGE_EXTENSIONS</code> value. The function
returns the contents of the <code>/var/cpanel/packages/extensions/name.tt2</code> file for each package
extension in the list, where name represents the package extension&#39;s name.</p>
<p>For more information, read our
<a href="https://go.cpanel.net/GuidetoPackageExtensions">Guide to Package Extensions</a>.</p>
<p><strong>Note:</strong></p>
<p>This function returns only metadata if the hosting plan does not use package extensions, or
if the extensions&#39; template files are empty.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a hosting plan's package extension templates. When you call this
function, the system checks the hosting plan's <code>_PACKAGE_EXTENSIONS</code> value. The function
returns the contents of the <code>/var/cpanel/packages/extensions/name.tt2</code> file for each package
extension in the list, where name represents the package extension's name.</p>
<p>For more information, read our
<a href="https://go.cpanel.net/GuidetoPackageExtensions">Guide to Package Extensions</a>.</p>
<p><strong>Note:</strong></p>
<p>This function returns only metadata if the hosting plan does not use package extensions, or
if the extensions' template files are empty.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="pkg" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">pkg</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">pkg=package1</span></div><div><div html="<p>The hosting plan&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/_getpkgextensionform</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/_getpkgextensionform</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2af77a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2af77a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2af77a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af77a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2af77a:0" aria-labelledby="tab:R2af77a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
_getpkgextensionform <span class="token punctuation">\</span>
<span class="token assign-left variable">pkg</span><span class="token operator">=</span><span class="token string">'package1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2af77a:1" aria-labelledby="tab:R2af77a: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:R2ef77a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ef77a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ef77a:0" aria-labelledby="tab:R2ef77a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"html"</span>: <span class="token string">"<div class=\"fatBorder\" id=\"dog_Extension\"> <fieldset class=\"groupEditor\"> <div class=\"propertyGroup\"> <h3>Dog Settings</h3> <div class=\"propertyEditor\"> <div class=\"propertyLabel\">Dog Species</div> <div class=\"propertyValue\"><input id=\"dog_species\" type=\"text\" name=\"dog_species\" value=\"dalmatian\"></div> </div> <div class=\"propertyEditor\"> <div class=\"propertyLabel\">Tail Length</div> <div class=\"propertyValue\"> <input type=\"radio\" id=\"dogTailLengthTiny\" name=\"dog_tail_length\" value=\"tiny\"> <label for=\"dogTailLengthTiny\">Tiny</label><br> <input type=\"radio\" id=\"dogTailLengthNormal\" name=\"dog_tail_length\" value=\"normal\"> <label for=\"dogTailLengthNormal\">Normal</label><br> <input type=\"radio\" id=\"dogTailLengthLong\" name=\"dog_tail_length\" value=\"long\"> <label for=\"dogTailLengthLong\">Long</label> </div> </div> <div class=\"propertyEditor\"> <div class=\"propertyLabel\"><label for=\"dog_spots\">Has Spots</label></div> <div class=\"propertyValue\"> <input id=\"dog_spots\" type=\"checkbox\" name=\"dog_spots\" value=\"y\" checked=\"checked\"> </div> </div> </div> </fieldset> </div>"</span></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">"command"</span>: <span class="token string">"_getpkgextensionform"</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/Hosting-Plans" data-section-id="tag/Hosting-Plans" 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/Hosting-Plans" aria-label="tag/Hosting-Plans"></a>Hosting Plans</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Hosting Plans / Hosting Plans</p>
"><p>Hosting Plans / Hosting Plans</p>
</div></div></div><div id="tag/Hosting-Plans/operation/killpkg" data-section-id="tag/Hosting-Plans/operation/killpkg" class="sc-dntaoT ceciOs"><div data-section-id="operation/killpkg" id="operation/killpkg" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Hosting-Plans/operation/killpkg" aria-label="tag/Hosting-Plans/operation/killpkg"></a>Delete hosting plan<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deletes a hosting plan (package).</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a hosting plan (package).</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="pkgname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">pkgname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">pkgname=package1</span></div><div><div html="<p>The hosting plan&#39;s name.</p>
<p><strong>Note:</strong></p>
<p> You <strong>cannot</strong> delete a hosting plan that a cPanel account currently uses.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's name.</p>
<p><strong>Note:</strong></p>
<p> You <strong>cannot</strong> delete a hosting plan that a cPanel account currently uses.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/killpkg</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/killpkg</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj97a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj97a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj97a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj97a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj97a:0" aria-labelledby="tab:R4kj97a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
killpkg <span class="token punctuation">\</span>
<span class="token assign-left variable">pkgname</span><span class="token operator">=</span><span class="token string">'package1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj97a:1" aria-labelledby="tab:R4kj97a: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:R4sj97a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj97a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj97a:0" aria-labelledby="tab:R4sj97a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"killpkg"</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/Hosting-Plans/operation/addpkg" data-section-id="tag/Hosting-Plans/operation/addpkg" class="sc-dntaoT ceciOs"><div data-section-id="operation/addpkg" id="operation/addpkg" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Hosting-Plans/operation/addpkg" aria-label="tag/Hosting-Plans/operation/addpkg"></a>Create hosting plan<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates a hosting plan (package).</p>
<p><strong>Note:</strong></p>
<p>The <a href="https://go.cpanel.net/GuidetoWHMPluginsAccessControlLists">Access Control Lists</a>
restricts some of this function&#39;s parameters, which limit the features that
WHM users can access.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a hosting plan (package).</p>
<p><strong>Note:</strong></p>
<p>The <a href="https://go.cpanel.net/GuidetoWHMPluginsAccessControlLists">Access Control Lists</a>
restricts some of this function's parameters, which limit the features that
WHM users can access.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="_PACKAGE_EXTENSIONS" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">_PACKAGE_EXTENSIONS</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">_PACKAGE_EXTENSIONS='extension1 extension2 extension3'</span></div><div><div html="<p>A space-separated list of the hosting plan&#39;s
<a href="https://go.cpanel.net/GuidetoPackageExtensions">package extensions</a>.</p>
<p>If you do <strong>not</strong> provide a value, the hosting plan will <strong>not</strong> include package
extensions.</p>
<p><strong>Note:</strong></p>
<ul>
<li>We <strong>strongly</strong> recommend that you manage package extensions through WHM API
1&#39;s <code>addpkgext</code> and <code>delpkgext</code> functions.</li>
<li>You can include the extension&#39;s variables in your function call, in <code>key=value</code> format.
Consult the extension&#39;s documentation for a list of possible variables.</li>
<li>Extension names and variables are case-sensitive.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A space-separated list of the hosting plan's
<a href="https://go.cpanel.net/GuidetoPackageExtensions">package extensions</a>.</p>
<p>If you do <strong>not</strong> provide a value, the hosting plan will <strong>not</strong> include package
extensions.</p>
<p><strong>Note:</strong></p>
<ul>
<li>We <strong>strongly</strong> recommend that you manage package extensions through WHM API
1's <code>addpkgext</code> and <code>delpkgext</code> functions.</li>
<li>You can include the extension's variables in your function call, in <code>key=value</code> format.
Consult the extension's documentation for a list of possible variables.</li>
<li>Extension names and variables are case-sensitive.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="bwlimit" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand bwlimit"><span class="property-name">bwlimit</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or any or string</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1048576</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">bwlimit=1048576</span></div><div><div html="<p>The hosting plan&#39;s maximum bandwidth use, in megabytes (MB).</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited bandwidth.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The <code>0</code>, <code>unlimited</code>, and <code>null</code> values are <strong>only</strong> available to users that possess
the corresponding unlimited ACL permission.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum bandwidth use, in megabytes (MB).</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited bandwidth.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The <code>0</code>, <code>unlimited</code>, and <code>null</code> values are <strong>only</strong> available to users that possess
the corresponding unlimited ACL permission.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="cgi" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cgi</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cgi=1</span></div><div><div html="<p>Whether CGI access is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<p>When a
<a href="https://go.cpanel.net/whmdocsServerProfile">server profile</a> disables the
<a href="https://go.cpanel.net/serverroles#roles">Web Server role</a>, this parameter
defaults to <code>0</code>. On these servers, you <strong>cannot</strong> enable CGI access.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether CGI access is enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<p>When a
<a href="https://go.cpanel.net/whmdocsServerProfile">server profile</a> disables the
<a href="https://go.cpanel.net/serverroles#roles">Web Server role</a>, this parameter
defaults to <code>0</code>. On these servers, you <strong>cannot</strong> enable CGI access.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="cpmod" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpmod</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cpmod=jupiter</span></div><div><div html="<p>The hosting plan&#39;s cPanel theme.</p>
<p>This parameter defaults to the server&#39;s
<a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup#select-a-default-theme-for-the-cpanel-interface">default cPanel theme</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's cPanel theme.</p>
<p>This parameter defaults to the server's
<a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup#select-a-default-theme-for-the-cpanel-interface">default cPanel theme</a>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="digestauth" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">digestauth</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">digestauth=1</span></div><div><div html="<p>Whether to enable Digest Authentication for accounts on the hosting plan.</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 Digest Authentication for accounts on the hosting plan.</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="featurelist" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">featurelist</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"default"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">featurelist=feature_list</span></div><div><div html="<p>The hosting plan&#39;s feature list.</p>
<p>If you do <strong>not</strong> use this parameter, the function assigns the <code>default</code>
feature list to the account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's feature list.</p>
<p>If you do <strong>not</strong> use this parameter, the function assigns the <code>default</code>
feature list to the account.</p>
</div></div></div></td></tr><tr class=""><td class="sc-ovuCP sc-eauhAA dEkioI iQpMVv deprecated" kind="field" title="frontpage"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">frontpage</span></td><td class="sc-fFoeYl dYBdBR"><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">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">frontpage=0</span></div><div><div html="<p>Whether Microsoft® FrontPage® Extensions are enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<p>cPanel &amp; WHM ignores all FrontPage settings and parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether Microsoft® FrontPage® Extensions are enabled for the account.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<p>cPanel & WHM ignores all FrontPage settings and parameters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="hasshell" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">hasshell</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">hasshell=1</span></div><div><div html="<p>Whether the hosting plan allows shell access.</p>
<ul>
<li><code>1</code> — The hosting plan allows shell access.</li>
<li><code>0</code> — The hosting plan does <strong>not</strong> allows shell access.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the hosting plan allows shell access.</p>
<ul>
<li><code>1</code> — The hosting plan allows shell access.</li>
<li><code>0</code> — The hosting plan does <strong>not</strong> allows shell access.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"n"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"y"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"n"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=n</span></div><div><div html="<p>Whether the account has a dedicated IP address.</p>
<ul>
<li><code>y</code> — The account possesses a dedicated IP address.</li>
<li><code>n</code> — The account does not possess a dedicated IP address.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the account has a dedicated IP address.</p>
<ul>
<li><code>y</code> — The account possesses a dedicated IP address.</li>
<li><code>n</code> — The account does not possess a dedicated IP address.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="language" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">language</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">language=en</span></div><div><div html="<p>The hosting plan&#39;s default locale, in its two-letter
<a href="http://www.iso.org/iso/country_codes.htm">ISO-3166 code</a>
format.</p>
<p>This parameter defaults to the server&#39;s default locale.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's default locale, in its two-letter
<a href="http://www.iso.org/iso/country_codes.htm">ISO-3166 code</a>
format.</p>
<p>This parameter defaults to the server's default locale.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAX_DEFER_FAIL_PERCENTAGE" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAX_DEFER_FAIL_PERCENTAGE"><span class="property-name">MAX_DEFER_FAIL_PERCENTAGE</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><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">MAX_DEFER_FAIL_PERCENTAGE=unlimited</span></div><div><div html="<p>The percentage of failed or deferred email messages that the hosting plan allows users
to send per hour before outgoing mail is rate-limited.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The hosting plan allows users ot send an unlimited number of
failed or deferred messages.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The percentage of failed or deferred email messages that the hosting plan allows users
to send per hour before outgoing mail is rate-limited.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The hosting plan allows users ot send an unlimited number of
failed or deferred messages.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAX_EMAIL_PER_HOUR" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAX_EMAIL_PER_HOUR"><span class="property-name">MAX_EMAIL_PER_HOUR</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><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">MAX_EMAIL_PER_HOUR=unlimited</span></div><div><div html="<p>The maximum number of emails that the hosting plan allows users to send in one hour.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The hosting plan allows users to send an unlimited number of emails.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of emails that the hosting plan allows users to send in one hour.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The hosting plan allows users to send an unlimited number of emails.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_emailacct_quota" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand max_emailacct_quota"><span class="property-name">max_emailacct_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">integer or any or any or string</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1024</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">max_emailacct_quota=1024</span></div><div><div html="<p>The hosting plan&#39;s maximum email account quota size, in megabytes (MB).</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited email account quota.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The <code>0</code>, <code>unlimited</code>, and <code>null</code> values are <strong>only</strong> available to users that possess
the corresponding unlimited ACL permission.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum email account quota size, in megabytes (MB).</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited email account quota.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The <code>0</code>, <code>unlimited</code>, and <code>null</code> values are <strong>only</strong> available to users that possess
the corresponding unlimited ACL permission.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_team_users" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">max_team_users</span></td><td class="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 .. 7 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">max_team_users=7</span></div><div><div html="<p>The hosting plan&#39;s maximum number of Team users.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of Team users.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxaddon" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxaddon"><span class="property-name">maxaddon</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or any or string</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">maxaddon=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of addon domains.</p>
<ul>
<li><code>unlimited</code> or <code>null</code> — The hosting plan allows unlimited addon domains.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of addon domains.</p>
<ul>
<li><code>unlimited</code> or <code>null</code> — The hosting plan allows unlimited addon domains.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxftp" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxftp"><span class="property-name">maxftp</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or any or string</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">maxftp=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of FTP accounts.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited FTP accounts.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of FTP accounts.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited FTP accounts.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxlst" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxlst"><span class="property-name">maxlst</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or any or string</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">maxlst=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of mailing lists.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited mailing lists.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of mailing lists.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited mailing lists.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxpark" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxpark"><span class="property-name">maxpark</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or any or string</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">maxpark=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of parked domains (aliases).</p>
<ul>
<li><code>unlimited</code> or <code>null</code> — The hosting plan allows unlimited parked domains.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of parked domains (aliases).</p>
<ul>
<li><code>unlimited</code> or <code>null</code> — The hosting plan allows unlimited parked domains.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxpop" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxpop"><span class="property-name">maxpop</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or any or string</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">maxpop=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of email accounts.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited email accounts.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of email accounts.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited email accounts.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxsql" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxsql"><span class="property-name">maxsql</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or any or string</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">maxsql=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of each available type of SQL
database.</p>
<p>For example, if you set this value to <code>5</code> and the system administrator
allows MySQL® and PostgreSQL® databases, users can create up to five MySQL
databases and up to five PostgreSQL databases.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting allows unlimited databases.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of each available type of SQL
database.</p>
<p>For example, if you set this value to <code>5</code> and the system administrator
allows MySQL® and PostgreSQL® databases, users can create up to five MySQL
databases and up to five PostgreSQL databases.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting allows unlimited databases.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxsub" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxsub"><span class="property-name">maxsub</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or any or string</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">maxsub=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of subdomains.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited subdomains.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of subdomains.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited subdomains.</li>
</ul>
</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=package1</span></div><div><div html="<p>The new hosting plan&#39;s name.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>cannot</strong> use the name <code>extensions</code> for a hosting plan.</li>
<li>You <strong>cannot</strong> modify hosting plan names after creation. Do <strong>not</strong>
include details that may change over time, such as price.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new hosting plan's name.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>cannot</strong> use the name <code>extensions</code> for a hosting plan.</li>
<li>You <strong>cannot</strong> modify hosting plan names after creation. Do <strong>not</strong>
include details that may change over time, such as price.</li>
</ul>
</div></div></div></td></tr><tr class="last "><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">integer or any or any or string</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">10240</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">quota=10240</span></div><div><div html="<p>The hosting plan&#39;s disk space quota, in megabytes (MB).</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited disk space.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The <code>0</code>, <code>unlimited</code>, and <code>null</code> values are <strong>only</strong> available to users that possess
the corresponding unlimited ACL permission.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's disk space quota, in megabytes (MB).</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited disk space.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The <code>0</code>, <code>unlimited</code>, and <code>null</code> values are <strong>only</strong> available to users that possess
the corresponding unlimited ACL permission.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/addpkg</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/addpkg</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl97a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl97a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl97a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl97a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl97a:0" aria-labelledby="tab:R4kl97a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
addpkg <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'package1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl97a:1" aria-labelledby="tab:R4kl97a: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:R4sl97a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl97a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl97a:0" aria-labelledby="tab:R4sl97a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"pkg"</span>: <span class="token string">"package1"</span></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">"command"</span>: <span class="token string">"addpkg"</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/Hosting-Plans/operation/editpkg" data-section-id="tag/Hosting-Plans/operation/editpkg" class="sc-dntaoT ceciOs"><div data-section-id="operation/editpkg" id="operation/editpkg" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Hosting-Plans/operation/editpkg" aria-label="tag/Hosting-Plans/operation/editpkg"></a>Update hosting plan<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function edits a hosting plan (package).</p>
<p><strong>Note:</strong></p>
<ul>
<li>The
<a href="https://go.cpanel.net/GuidetoWHMPluginsAccessControlLists">Access Control List (ACL)</a>
restricts some of the function&#39;s parameters, which limit the features that WHM
users can access.</li>
<li>This function applies any changes you make to <strong>all</strong> accounts that exist on
the hosting plan.</li>
<li>This function <strong>cannot</strong> modify hosting plan names.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function edits a hosting plan (package).</p>
<p><strong>Note:</strong></p>
<ul>
<li>The
<a href="https://go.cpanel.net/GuidetoWHMPluginsAccessControlLists">Access Control List (ACL)</a>
restricts some of the function's parameters, which limit the features that WHM
users can access.</li>
<li>This function applies any changes you make to <strong>all</strong> accounts that exist on
the hosting plan.</li>
<li>This function <strong>cannot</strong> modify hosting plan names.</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="_PACKAGE_EXTENSIONS" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">_PACKAGE_EXTENSIONS</span></td><td class="sc-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">_PACKAGE_EXTENSIONS=extension1 extension2 extension3</span> -<!-- --> <!-- -->Add multiple package extensions.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">_PACKAGE_EXTENSIONS=extension1</span> -<!-- --> <!-- -->Add a single package.</li></ul><div><div html="<p>The hosting plan&#39;s <a href="https://go.cpanel.net/GuidetoPackageExtensions">package extensions</a>.</p>
<p>If you do <strong>not</strong> provide a value, the hosting plan will <strong>not</strong> include package
extensions.</p>
<p><strong>Note:</strong></p>
<ul>
<li>We <strong>strongly</strong> recommend that you manage package extensions through WHM API
1&#39;s <code>addpkgext</code> and <code>delpkgext</code> functions.</li>
<li>You can include the extension&#39;s variables in your function call, in <code>key=value</code> format.
Consult the extension&#39;s documentation for a list of possible variables.</li>
<li>Extension names and variables are case-sensitive.</li>
<li>Use space-delimited format to add multiple package extensions.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's <a href="https://go.cpanel.net/GuidetoPackageExtensions">package extensions</a>.</p>
<p>If you do <strong>not</strong> provide a value, the hosting plan will <strong>not</strong> include package
extensions.</p>
<p><strong>Note:</strong></p>
<ul>
<li>We <strong>strongly</strong> recommend that you manage package extensions through WHM API
1's <code>addpkgext</code> and <code>delpkgext</code> functions.</li>
<li>You can include the extension's variables in your function call, in <code>key=value</code> format.
Consult the extension's documentation for a list of possible variables.</li>
<li>Extension names and variables are case-sensitive.</li>
<li>Use space-delimited format to add multiple package extensions.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="bwlimit" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand bwlimit"><span class="property-name">bwlimit</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or string</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1048576</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">bwlimit=1048576</span></div><div><div html="<p>The hosting plan&#39;s maximum bandwidth use, in megabytes (MB).</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited
bandwidth.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The <code>0</code>, <code>unlimited</code>, or <code>null</code> values are <strong>only</strong> available to
users that possess the corresponding <code>unlimited</code> ACL permission.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum bandwidth use, in megabytes (MB).</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited
bandwidth.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The <code>0</code>, <code>unlimited</code>, or <code>null</code> values are <strong>only</strong> available to
users that possess the corresponding <code>unlimited</code> ACL permission.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="cgi" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cgi</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cgi=1</span></div><div><div html="<p>Whether CGI access is enabled for the hosting plan.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<p>When a <a href="https://go.cpanel.net/whmdocsServerProfile">server profile</a> disables
the <a href="https://go.cpanel.net/serverroles#roles">Web Server role</a>, this parameter
defaults to <code>0</code>. On these servers, you <strong>cannot</strong> enable CGI access.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether CGI access is enabled for the hosting plan.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<p>When a <a href="https://go.cpanel.net/whmdocsServerProfile">server profile</a> disables
the <a href="https://go.cpanel.net/serverroles#roles">Web Server role</a>, this parameter
defaults to <code>0</code>. On these servers, you <strong>cannot</strong> enable CGI access.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="cpmod" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cpmod</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cpmod=jupiter</span></div><div><div html="<p>The hosting plan&#39;s cPanel theme.</p>
<p>This parameter defaults to the server&#39;s
<a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup">default cPanel theme</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's cPanel theme.</p>
<p>This parameter defaults to the server's
<a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup">default cPanel theme</a>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="digestauth" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">digestauth</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">digestauth=1</span></div><div><div html="<p>Whether to enable Digest Authentication for accounts on the hosting plan.</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 Digest Authentication for accounts on the hosting plan.</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="featurelist" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">featurelist</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"default"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">featurelist=default</span></div><div><div html="<p>The hosting plan&#39;s feature list.</p>
<p>If you do <strong>not</strong> use this parameter, the function assigns the <code>default</code>
feature list to the hosting plan&#39;s accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's feature list.</p>
<p>If you do <strong>not</strong> use this parameter, the function assigns the <code>default</code>
feature list to the hosting plan's accounts.</p>
</div></div></div></td></tr><tr class=""><td class="sc-ovuCP sc-eauhAA dEkioI iQpMVv deprecated" kind="field" title="frontpage"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">frontpage</span></td><td class="sc-fFoeYl dYBdBR"><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">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">frontpage=0</span></div><div><div html="<p>Whether Microsoft® FrontPage Extensions are enabled for the account.</p>
<p><strong>Note:</strong></p>
<p>cPanel &amp; WHM ignores all FrontPage settings and parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether Microsoft® FrontPage Extensions are enabled for the account.</p>
<p><strong>Note:</strong></p>
<p>cPanel & WHM ignores all FrontPage settings and parameters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="hasshell" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">hasshell</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">hasshell=1</span></div><div><div html="<p>Whether the hosting plan allows shell access.</p>
<ul>
<li><code>1</code> — The hosting plan allows shell access.</li>
<li><code>0</code> — The hosting plan does <strong>not</strong> allow shell access.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the hosting plan allows shell access.</p>
<ul>
<li><code>1</code> — The hosting plan allows shell access.</li>
<li><code>0</code> — The hosting plan does <strong>not</strong> allow shell access.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"n"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"y"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"n"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=n</span></div><div><div html="<p>Whether the hosting plan uses a dedicated IP address.</p>
<ul>
<li><code>y</code> — The hosting plan uses a dedicated IP address.</li>
<li><code>n</code> — The hosting plan does <strong>not</strong> use a dedicated IP address.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the hosting plan uses a dedicated IP address.</p>
<ul>
<li><code>y</code> — The hosting plan uses a dedicated IP address.</li>
<li><code>n</code> — The hosting plan does <strong>not</strong> use a dedicated IP address.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="language" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">language</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">language=en</span></div><div><div html="<p>The hosting plan&#39;s default locale.</p>
<p>This parameter defaults to the server&#39;s default locale.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's default locale.</p>
<p>This parameter defaults to the server's default locale.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_defer_fail_percentage" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand max_defer_fail_percentage"><span class="property-name">max_defer_fail_percentage</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><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">max_defer_fail_percentage=unlimited</span></div><div><div html="<p>The percentage of failed or deferred email messages that an account on the
hosting plan can send per hour before outgoing mail is rate-limited.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The hosting plan allows unlimited email messages per hour.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The percentage of failed or deferred email messages that an account on the
hosting plan can send per hour before outgoing mail is rate-limited.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The hosting plan allows unlimited email messages per hour.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_email_per_hour" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand max_email_per_hour"><span class="property-name">max_email_per_hour</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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><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">max_email_per_hour=unlimited</span></div><div><div html="<p>The maximum number of emails that the hosting plan allows accounts to send
in one hour.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The hosting plan allows unlimited emails per hour.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of emails that the hosting plan allows accounts to send
in one hour.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The hosting plan allows unlimited emails per hour.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_emailacct_quota" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand max_emailacct_quota"><span class="property-name">max_emailacct_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">integer or any or string</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1024</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">max_emailacct_quota=1024</span></div><div><div html="<p>The hosting plan&#39;s maximum email account quota size, in megabytes (MB).</p>
<ul>
<li><code>0</code>, <code>null, or </code>unlimited` — The hosting plan allows unlimited quota.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>This parameter does <strong>not</strong> affect any existing email accounts.</li>
<li>The <code>unlimited</code> value is <strong>only</strong> available to users that possess
the corresponding <code>unlimited</code> ACL permission.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum email account quota size, in megabytes (MB).</p>
<ul>
<li><code>0</code>, <code>null, or </code>unlimited` — The hosting plan allows unlimited quota.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>This parameter does <strong>not</strong> affect any existing email accounts.</li>
<li>The <code>unlimited</code> value is <strong>only</strong> available to users that possess
the corresponding <code>unlimited</code> ACL permission.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_team_users" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">max_team_users</span></td><td 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 .. 7 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">max_team_users=7</span></div><div><div html="<p>The hosting plan&#39;s maximum number of Team users.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of Team users.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxaddon" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxaddon"><span class="property-name">maxaddon</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or string</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">maxaddon=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of addon domains.</p>
<ul>
<li><code>unlimited</code> or <code>null</code> — The hosting plan allows unlimited
addon domains.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of addon domains.</p>
<ul>
<li><code>unlimited</code> or <code>null</code> — The hosting plan allows unlimited
addon domains.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxftp" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxftp"><span class="property-name">maxftp</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or string</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">maxftp=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of FTP accounts.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited databases.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of FTP accounts.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited databases.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxlst" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxlst"><span class="property-name">maxlst</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or string</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">maxlst=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of mailing lists.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited
mailing lists.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of mailing lists.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited
mailing lists.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxpark" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxpark"><span class="property-name">maxpark</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or string</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">maxpark=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of parked domains (aliases).</p>
<ul>
<li><code>unlimited</code> or <code>null</code> — The hosting plan allows unlimited parked
domains.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of parked domains (aliases).</p>
<ul>
<li><code>unlimited</code> or <code>null</code> — The hosting plan allows unlimited parked
domains.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxpop" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxpop"><span class="property-name">maxpop</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or string</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">maxpop=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of email accounts.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited
email accounts.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of email accounts.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited
email accounts.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxsql" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxsql"><span class="property-name">maxsql</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or string</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">maxsql=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of each available type of SQL
database.</p>
<p>For example, if you set this value to <code>5</code> and the system administrator
allows MySQL® and PostgreSQL® databases, users with this hosting plan
can create up to five MySQL databases and up to five PostgreSQL databases.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited
databases.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of each available type of SQL
database.</p>
<p>For example, if you set this value to <code>5</code> and the system administrator
allows MySQL® and PostgreSQL® databases, users with this hosting plan
can create up to five MySQL databases and up to five PostgreSQL databases.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited
databases.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxsub" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand maxsub"><span class="property-name">maxsub</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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 any or string</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">maxsub=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of subdomains.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited
subdomains.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of subdomains.</p>
<ul>
<li><code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited
subdomains.</li>
</ul>
</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=package1</span></div><div><div html="<p>The hosting plan&#39;s name. If the hosting plan does not exist, the system will create it.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's name. If the hosting plan does not exist, the system will create it.</p>
</div></div></div></td></tr><tr class="last "><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">integer or any or string</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">10240</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">quota=10240</span></div><div><div html="<p>The hosting plan&#39;s disk space quota, in megabytes (MB).</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited
disk space quota.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The <code>0</code>, <code>unlimited</code>, or <code>null</code> values are <strong>only</strong> available to
users that possess the corresponding <code>unlimited</code> ACL permission.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's disk space quota, in megabytes (MB).</p>
<ul>
<li><code>0</code>, <code>unlimited</code>, or <code>null</code> — The hosting plan allows unlimited
disk space quota.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The <code>0</code>, <code>unlimited</code>, or <code>null</code> values are <strong>only</strong> available to
users that possess the corresponding <code>unlimited</code> ACL permission.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/editpkg</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/editpkg</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn97a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn97a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn97a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn97a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn97a:0" aria-labelledby="tab:R4kn97a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
editpkg <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'package1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn97a:1" aria-labelledby="tab:R4kn97a: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:R4sn97a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn97a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn97a:0" aria-labelledby="tab:R4sn97a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"pkg"</span>: <span class="token string">"package1"</span></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">"command"</span>: <span class="token string">"editpkg"</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/Hosting-Plans/operation/listpkgs" data-section-id="tag/Hosting-Plans/operation/listpkgs" class="sc-dntaoT ceciOs"><div data-section-id="operation/listpkgs" id="operation/listpkgs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Hosting-Plans/operation/listpkgs" aria-label="tag/Hosting-Plans/operation/listpkgs"></a>Return current user's available hosting plans<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the authenticated user&#39;s available hosting plans (packages).</p>
<p><strong>Important:</strong></p>
<p>This function <strong>only</strong> returns packages that the authenticated user can access and
use during account creation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the authenticated user's available hosting plans (packages).</p>
<p><strong>Important:</strong></p>
<p>This function <strong>only</strong> returns packages that the authenticated user can access and
use during account creation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="want" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">want</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"all"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"creatable"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"editable"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"viewable"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">want=all</span></div><div><div html="<p>The permissions of packages that you wish to list.</p>
<ul>
<li><code>all</code> — All packages on the system.</li>
<li><code>creatable</code> — Packages that the authenticated user can use for accounts.</li>
<li><code>editable</code> — Packages that the authenticated user can edit.</li>
<li><code>viewable</code> — Packages that the authenticated user can view.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The permissions of packages that you wish to list.</p>
<ul>
<li><code>all</code> — All packages on the system.</li>
<li><code>creatable</code> — Packages that the authenticated user can use for accounts.</li>
<li><code>editable</code> — Packages that the authenticated user can edit.</li>
<li><code>viewable</code> — Packages that the authenticated user can view.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/listpkgs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/listpkgs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp97a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp97a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp97a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp97a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp97a:0" aria-labelledby="tab:R4kp97a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
listpkgs
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp97a:1" aria-labelledby="tab:R4kp97a: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:R4sp97a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp97a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp97a:0" aria-labelledby="tab:R4sp97a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"pkg"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"BWLIMIT"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CGI"</span>: <span class="token string">"y"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CPMOD"</span>: <span class="token string">"jupiter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DIGESTAUTH"</span>: <span class="token string">"n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FEATURELIST"</span>: <span class="token string">"myfeaturelist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASSHELL"</span>: <span class="token string">"n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"IP"</span>: <span class="token string">"n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"LANG"</span>: <span class="token string">"en"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXADDON"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXFTP"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXLST"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPARK"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPOP"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSQL"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSUB"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_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">"MAX_EMAILACCT_QUOTA"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_EMAIL_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">"MAX_TEAM_USERS"</span>: <span class="token number">7</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"QUOTA"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_PACKAGE_EXTENSIONS"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"package1"</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">"metadata"</span>: <button class="collapser" aria-label="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">"listpkgs"</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/Hosting-Plans/operation/matchpkgs" data-section-id="tag/Hosting-Plans/operation/matchpkgs" class="sc-dntaoT ceciOs"><div data-section-id="operation/matchpkgs" id="operation/matchpkgs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Hosting-Plans/operation/matchpkgs" aria-label="tag/Hosting-Plans/operation/matchpkgs"></a>Return filtered hosting plans<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function matches the server&#39;s hosting plans (packages) against
your criteria.</p>
<p><strong>Note:</strong></p>
<p>If you do not include <strong>any</strong> input parameters, the function lists <strong>all</strong> of
the server&#39;s packages.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function matches the server's hosting plans (packages) against
your criteria.</p>
<p><strong>Note:</strong></p>
<p>If you do not include <strong>any</strong> input parameters, the function lists <strong>all</strong> of
the server's packages.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="_PACKAGE_EXTENSIONS" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">_PACKAGE_EXTENSIONS</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">_PACKAGE_EXTENSIONS='ext1 ext2 ext3'</span></div><div><div html="<p>A space-separated list of one or more of the hosting plan&#39;s package extensions.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A space-separated list of one or more of the hosting plan's package extensions.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="BWLIMIT" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand BWLIMIT"><span class="property-name">BWLIMIT</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">BWLIMIT=unlimited</span></div><div><div html="<p>The hosting plan&#39;s bandwidth limit.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows unlimited bandwidth.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's bandwidth limit.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows unlimited bandwidth.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="CGI" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">CGI</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">CGI=1</span></div><div><div html="<p>Whether CGI is enabled for the hosting plan.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether CGI is enabled for the hosting plan.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="CPMOD" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">CPMOD</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">CPMOD=jupiter</span></div><div><div html="<p>The hosting plan&#39;s cPanel interface theme.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's cPanel interface theme.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="DIGESTAUTH" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">DIGESTAUTH</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"y"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"n"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">DIGESTAUTH=n</span></div><div><div html="<p>Whether the hosting plan enables Digest Authentication.</p>
<ul>
<li><code>y</code> — Enabled.</li>
<li><code>n</code> — Disabled.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the hosting plan enables Digest Authentication.</p>
<ul>
<li><code>y</code> — Enabled.</li>
<li><code>n</code> — Disabled.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="FEATURELIST" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">FEATURELIST</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">FEATURELIST=myfeaturelist</span></div><div><div html="<p>The hosting plan&#39;s <a href="https://go.cpanel.net/whmdocsFeatureManager">feature list</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's <a href="https://go.cpanel.net/whmdocsFeatureManager">feature list</a>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="HASSHELL" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">HASSHELL</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">HASSHELL=1</span></div><div><div html="<p>Whether shell access is enabled for the hosting plan.</p>
<ul>
<li><code>1</code> — Enabled</li>
<li><code>0</code> — Disabled.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether shell access is enabled for the hosting plan.</p>
<ul>
<li><code>1</code> — Enabled</li>
<li><code>0</code> — Disabled.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="IP" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"y"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"n"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">IP=n</span></div><div><div html="<p>Whether the hosting plan grants accounts a dedicated IP address.</p>
<ul>
<li><code>y</code> — Dedicated IP address.</li>
<li><code>n</code> — Shared IP address.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the hosting plan grants accounts a dedicated IP address.</p>
<ul>
<li><code>y</code> — Dedicated IP address.</li>
<li><code>n</code> — Shared IP address.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="LANG" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">LANG</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">LANG=en</span></div><div><div html="<p>The hosting plan&#39;s locale.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's locale.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAX_DEFER_FAIL_PERCENTAGE" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAX_DEFER_FAIL_PERCENTAGE"><span class="property-name">MAX_DEFER_FAIL_PERCENTAGE</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAX_DEFER_FAIL_PERCENTAGE=unlimited</span></div><div><div html="<p>The
<a href="https://go.cpanel.net/howtopreventspam">percentage of failed or deferred email messages</a>
that the hosting plan can send per hour before the system rate-limits
outgoing mail.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows unlimited email messages.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The
<a href="https://go.cpanel.net/howtopreventspam">percentage of failed or deferred email messages</a>
that the hosting plan can send per hour before the system rate-limits
outgoing mail.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows unlimited email messages.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAX_EMAIL_PER_HOUR" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAX_EMAIL_PER_HOUR"><span class="property-name">MAX_EMAIL_PER_HOUR</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAX_EMAIL_PER_HOUR=unlimited</span></div><div><div html="<p>The <a href="https://go.cpanel.net/howtopreventspam">maximum number of emails</a>
that the hosting plan can send in one hour.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows unlimited emails per hour.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://go.cpanel.net/howtopreventspam">maximum number of emails</a>
that the hosting plan can send in one hour.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows unlimited emails per hour.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAX_EMAILACCT_QUOTA" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAX_EMAILACCT_QUOTA"><span class="property-name">MAX_EMAILACCT_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">integer or string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAX_EMAILACCT_QUOTA=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum email account quota size, in megabytes (MB).</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows an unlimited email account quota size.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum email account quota size, in megabytes (MB).</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows an unlimited email account quota size.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAX_TEAM_USERS" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">MAX_TEAM_USERS</span></td><td 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 .. 7 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAX_TEAM_USERS=7</span></div><div><div html="<p>The hosting plan&#39;s maximum number of Team users.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of Team users.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXADDON" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXADDON"><span class="property-name">MAXADDON</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXADDON=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of addon domains.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows unlimited addon domains.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of addon domains.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows unlimited addon domains.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXFTP" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXFTP"><span class="property-name">MAXFTP</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXFTP=2</span></div><div><div html="<p>The hosting plan&#39;s maximum number of FTP accounts.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows for unlimited FTP accounts.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of FTP accounts.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows for unlimited FTP accounts.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXLST" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXLST"><span class="property-name">MAXLST</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXLST=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of mailing lists.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows an unlimited number of mailing lists.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of mailing lists.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows an unlimited number of mailing lists.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXPARK" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXPARK"><span class="property-name">MAXPARK</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXPARK=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of parked domains (aliases).</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows unlimited parked domains.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of parked domains (aliases).</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows unlimited parked domains.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXPOP" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXPOP"><span class="property-name">MAXPOP</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXPOP=unlimited</span></div><div><div html="<p>The hosing plan&#39;s maximum number of email accounts.</p>
<ul>
<li><code>unlimited</code> — The hosting plan&#39;s can create unlimited email accounts.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosing plan's maximum number of email accounts.</p>
<ul>
<li><code>unlimited</code> — The hosting plan's can create unlimited email accounts.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXSQL" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXSQL"><span class="property-name">MAXSQL</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXSQL=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of SQL databases.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows unlimited SQL databases.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of SQL databases.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows unlimited SQL databases.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="MAXSUB" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand MAXSUB"><span class="property-name">MAXSUB</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">MAXSUB=unlimited</span></div><div><div html="<p>The hosting plan&#39;s maximum number of subdomains.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows unlimited subdomains.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's maximum number of subdomains.</p>
<ul>
<li><code>unlimited</code> — The hosting plan allows unlimited subdomains.</li>
</ul>
</div></div></div></td></tr><tr class="last "><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">integer or string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">QUOTA=unlimited</span></div><div><div html="<p>The hosting plan&#39;s disk space limit.</p>
<ul>
<li><code>unlimited</code> — The hosting plan has unlimited disk space.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan's disk space limit.</p>
<ul>
<li><code>unlimited</code> — The hosting plan has unlimited disk space.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/matchpkgs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/matchpkgs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kr97a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr97a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr97a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr97a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr97a:0" aria-labelledby="tab:R4kr97a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
matchpkgs
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr97a:1" aria-labelledby="tab:R4kr97a: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:R4sr97a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr97a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr97a:0" aria-labelledby="tab:R4sr97a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"pkg"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"BWLIMIT"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CGI"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CPMOD"</span>: <span class="token string">"jupiter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DIGESTAUTH"</span>: <span class="token string">"y"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FEATURELIST"</span>: <span class="token string">"myfeaturelist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FRONTPAGE"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASSHELL"</span>: <span class="token string">"n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"IP"</span>: <span class="token string">"n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"LANG"</span>: <span class="token string">"en"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXADDON"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXFTP"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXLST"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPARK"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPOP"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSQL"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSUB"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_DEFER_FAIL_PERCENTAGE"</span>: <span class="token number">10</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_EMAILACCT_QUOTA"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_EMAIL_PER_HOUR"</span>: <span class="token number">100</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_PACKAGE_EXTENSIONS"</span>: <span class="token string">"ext1 ext2 ext3"</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"matchpkgs"</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/Hosting-Plans/operation/getpkginfo" data-section-id="tag/Hosting-Plans/operation/getpkginfo" class="sc-dntaoT ceciOs"><div data-section-id="operation/getpkginfo" id="operation/getpkginfo" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Hosting-Plans/operation/getpkginfo" aria-label="tag/Hosting-Plans/operation/getpkginfo"></a>Return hosting plan configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists a hosting plan&#39;s (package&#39;s) settings.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a hosting plan's (package'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="pkg" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">pkg</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">pkg=package1</span></div><div><div html="<p>The hosting plan&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hosting plan'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/getpkginfo</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/getpkginfo</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kt97a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kt97a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kt97a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt97a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kt97a:0" aria-labelledby="tab:R4kt97a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
getpkginfo <span class="token punctuation">\</span>
<span class="token assign-left variable">pkg</span><span class="token operator">=</span><span class="token string">'package1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt97a:1" aria-labelledby="tab:R4kt97a: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:R4st97a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4st97a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4st97a:0" aria-labelledby="tab:R4st97a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"pkg"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"BWLIMIT"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CGI"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"CPMOD"</span>: <span class="token string">"jupiter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DIGESTAUTH"</span>: <span class="token string">"n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FEATURELIST"</span>: <span class="token string">"myfeaturelist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FRONTPAGE"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HASSHELL"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"IP"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"LANG"</span>: <span class="token string">"en"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXADDON"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXFTP"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXLST"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPARK"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXPOP"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSQL"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAXSUB"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_DEFER_FAIL_PERCENTAGE"</span>: <span class="token number">10</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_EMAILACCT_QUOTA"</span>: <span class="token string">"unlimited"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_EMAIL_PER_HOUR"</span>: <span class="token number">100</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_TEAM_USERS"</span>: <span class="token number">7</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_PACKAGE_EXTENSIONS"</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">"metadata"</span>: <button class="collapser" aria-label="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">"getpkginfo"</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/API-Authentication" data-section-id="tag/API-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/API-Authentication" aria-label="tag/API-Authentication"></a>API Authentication</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Integrations / API Authentication</p>
"><p>Integrations / API Authentication</p>
</div></div></div><div id="tag/API-Authentication/operation/get_remote_access_hash" data-section-id="tag/API-Authentication/operation/get_remote_access_hash" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_remote_access_hash" id="operation/get_remote_access_hash" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/API-Authentication/operation/get_remote_access_hash" aria-label="tag/API-Authentication/operation/get_remote_access_hash"></a>Return remote access file's hash<!-- --> <span type="warning" class="sc-jtQUzJ jmDXKf"> Deprecated </span></h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves a hash from a remote access file.</p>
<p><strong>Warning:</strong></p>
<p>We deprecated this function. We <strong>strongly</strong> suggest that you use the WHM API 1 <code>api_token_list</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a hash from a remote access file.</p>
<p><strong>Warning:</strong></p>
<p>We deprecated this function. We <strong>strongly</strong> suggest that you use the WHM API 1 <code>api_token_list</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="generate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">generate</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">generate=1</span></div><div><div html="<p>Whether to generate a new hash for the user, if one does not exist.</p>
<ul>
<li><code>1</code> — Generate a new hash.</li>
<li><code>0</code> — Do <strong>not</strong> generate a new hash.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to generate a new hash for the user, if one does not exist.</p>
<ul>
<li><code>1</code> — Generate a new hash.</li>
<li><code>0</code> — Do <strong>not</strong> generate a new hash.</li>
</ul>
</div></div></div></td></tr><tr class=""><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=hostname.example.com</span></div><div><div html="<p>The server&#39;s hostname.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server's hostname.</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 user&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user's password.</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=user</span></div><div><div html="<p>The user&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_remote_access_hash</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_remote_access_hash</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijj7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijj7q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijj7q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijj7q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijj7q:0" aria-labelledby="tab:Rijj7q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_remote_access_hash <span class="token punctuation">\</span>
<span class="token assign-left variable">username</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> <span class="token punctuation">\</span>
<span class="token assign-left variable">host</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:Rijj7q:1" aria-labelledby="tab:Rijj7q: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:Rjjj7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjj7q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjj7q:0" aria-labelledby="tab:Rjjj7q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"accesshash"</span>: <span class="token string">"6b355856c00606648b803a7d896186632472d584eaf0dad878b8885e1f64edad24b31ff79f2675303a598ac211ad5188c589fb60c5786a3e8d85c2029ca4ea76edb62becff7e3f7c5421f51bb4896737c22eda761e2a6fd96404bf513ee9051480ea86c800ab9b45f5255590836c7b769816a8f7f5def1e0c6cb19c212f01f56bb3392854ce51178a943eab6d1ce5d44857e980f70724f50964d2fbe01cb076a119dc5bf421051c2a0882550cdc69872832167c91e11bbe5c95d98474096ebe14b6ca9da2d73faecea5ec37f208912f5da578d5f8ab7c257584002e1808614f9859dceae564e8f30a9790c232d005ebd44f912e20b72e731fc600156e5b9f2902b0dd913010022e6b0deb6a2fb0d38ff3fd005c53f321ec812d3be10643dce81c46e1b9e2abe8814d46ba49b8a173b3e01ec677ea182cabb55db6d9eab2240755be1bbb1d7094a155fd262934ec099fdba3b10f409dced62d3d570ab6478a269a95da1314a45a5916da07312bf7e5a53d57b090e9c24932776f7ffdcf90ba2fa5cd935995795348b67311185f54da6b90da8771585e78c5f587e427bead9198faaa631b8216099c25373c8d4c26a011f295188963840777d09d95b6385df8337098b7e231534323457b9388fe9ea8046"</span></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">"command"</span>: <span class="token string">"get_remote_access_hash"</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/Links" data-section-id="tag/Links" 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/Links" aria-label="tag/Links"></a>Links</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Integrations / Links</p>
"><p>Integrations / Links</p>
</div></div></div><div id="tag/Links/operation/create_integration_group" data-section-id="tag/Links/operation/create_integration_group" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_integration_group" id="operation/create_integration_group" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Links/operation/create_integration_group" aria-label="tag/Links/operation/create_integration_group"></a>Create integration link group<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates a group to store integrations links in the cPanel interface.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a group to store integrations links in 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><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="group_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">group_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">group_id=WHMCS</span></div><div><div html="<p>The group&#39;s ID within the system.</p>
<p><strong>Warning:</strong></p>
<p> If you create a link with a <code>group_id</code> value that already exists, the function replaces the existing group with the newly-created group.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The group's ID within the system.</p>
<p><strong>Warning:</strong></p>
<p> If you create a link with a <code>group_id</code> value that already exists, the function replaces the existing group with the newly-created group.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="label" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">label</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">label=WHMCS+Control</span></div><div><div html="<p>The label for the group to display in the cPanel interface.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The label for the group to display in the cPanel interface.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="order" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">order</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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=1</span></div><div><div html="<p>The order in which to display the group in the cPanel interface.</p>
<p><strong>Note:</strong></p>
<p> By default, the function will automatically create an item under the username menu in the interface header.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The order in which to display the group in the cPanel interface.</p>
<p><strong>Note:</strong></p>
<p> By default, the function will automatically create an item under the username menu in the interface header.</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=username</span></div><div><div html="<p>The cPanel account name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="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">/create_integration_group</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/create_integration_group</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4khl7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4khl7q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4khl7q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4khl7q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4khl7q:0" aria-labelledby="tab:R4khl7q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
create_integration_group <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">group_id</span><span class="token operator">=</span><span class="token string">'WHMCS'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">label</span><span class="token operator">=</span><span class="token string">'WHMCS+Control'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">order</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:R4khl7q:1" aria-labelledby="tab:R4khl7q: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:R4shl7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4shl7q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4shl7q:0" aria-labelledby="tab:R4shl7q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"create_integration_group"</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/Links/operation/create_integration_link" data-section-id="tag/Links/operation/create_integration_link" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_integration_link" id="operation/create_integration_link" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Links/operation/create_integration_link" aria-label="tag/Links/operation/create_integration_link"></a>Create integration link<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates an integration link in the cPanel interface.</p>
<p><strong>Note:</strong></p>
<p>The function creates the <code>APP.adminconfig</code> and <code>APP.userconfig</code> integration link files in the <code>/var/cpanel/integration/links/USERNAME</code> directory, where <code>APP</code> represents the application name and <code>USERNAME</code> represents the user for whom you create integration links.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates an integration link in the cPanel interface.</p>
<p><strong>Note:</strong></p>
<p>The function creates the <code>APP.adminconfig</code> and <code>APP.userconfig</code> integration link files in the <code>/var/cpanel/integration/links/USERNAME</code> directory, where <code>APP</code> represents the application name and <code>USERNAME</code> represents the user for whom you create integration links.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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" 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=WHMCS_billing</span></div><div><div html="<p>The application to link.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you create a link with an <code>app</code> value that already exists, the function will replace the existing link with the newly-created link.</li>
<li>The value you assign to the <code>app</code> parameter is how you identify that integration link when listing or removing integration links.</li>
<li>You may include underscore (<code>_</code>) characters.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application to link.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you create a link with an <code>app</code> value that already exists, the function will replace the existing link with the newly-created link.</li>
<li>The value you assign to the <code>app</code> parameter is how you identify that integration link when listing or removing integration links.</li>
<li>You may include underscore (<code>_</code>) characters.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="autologin_token_url" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">autologin_token_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"> <!-- --><<!-- -->json<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">autologin_token_url=http://www.example.com/login.cgi</span></div><div><div html="<p>The URL to which the server will send the <code>app</code>, <code>token</code>, <code>user</code>, and <code>subscriber_unique_id</code> values through an <code>HTTP POST</code> request. The destination server will respond with a JSON-encoded object with either a <code>redirect_url</code> key or the <code>retry</code> and <code>attempt</code> keys.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>must</strong> include either the <code>autologin_token_url</code> parameter, the <code>url</code> parameter, or both.</li>
<li>If you do not set the <code>autologin_token_url</code> parameter, or that server does not respond or exist, then the server will redirect the user to the location in the <code>url</code> parameter.</li>
<li>If the response contains <code>redirect_url</code>, the system will redirect the user to that URL. (For example:, <code>{&quot;redirect_url&quot;:&quot; http://www.whmcs.com/client_area/login/?one_time_user_token_that_expires_in_120_seconds=d41d8cd98f00 ”}</code> will send the user to that unique URL.)</li>
<li>If the response contains <code>retry</code> and <code>attempt</code>, the system will wait for the retry value in seconds for a maximum of 60 seconds and then attempt the call again. The attempt value indicates the number of attempts that your system has tried. The system will stop after three attempts. (For example, <code>{&quot;retry&quot;:30, &quot;attempt&quot;:2}</code> represents the second attempt to connect, and the system will pause the user for 30 seconds before it tries again.)</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The URL to which the server will send the <code>app</code>, <code>token</code>, <code>user</code>, and <code>subscriber_unique_id</code> values through an <code>HTTP POST</code> request. The destination server will respond with a JSON-encoded object with either a <code>redirect_url</code> key or the <code>retry</code> and <code>attempt</code> keys.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>must</strong> include either the <code>autologin_token_url</code> parameter, the <code>url</code> parameter, or both.</li>
<li>If you do not set the <code>autologin_token_url</code> parameter, or that server does not respond or exist, then the server will redirect the user to the location in the <code>url</code> parameter.</li>
<li>If the response contains <code>redirect_url</code>, the system will redirect the user to that URL. (For example:, <code>{"redirect_url":" http://www.whmcs.com/client_area/login/?one_time_user_token_that_expires_in_120_seconds=d41d8cd98f00 ”}</code> will send the user to that unique URL.)</li>
<li>If the response contains <code>retry</code> and <code>attempt</code>, the system will wait for the retry value in seconds for a maximum of 60 seconds and then attempt the call again. The attempt value indicates the number of attempts that your system has tried. The system will stop after three attempts. (For example, <code>{"retry":30, "attempt":2}</code> represents the second attempt to connect, and the system will pause the user for 30 seconds before it tries again.)</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="base64_png_image" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">base64_png_image</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->base64 image<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">base64_png_image=iVBORw0KGgoAAAANSUhEUgAAAJgAAADYCAYAAA AXmipNAAAACXBIWXMAAALVAAAC1QHAwm8lAAAAGXRFWHRTb2Z0d2FyZQB 3d3cuaW5rc2NhcGUub3Jnm+48GgAAAUNJREFUeJztziFKg2EABuD3+ydz qGBwiGBZ385hstoMu4DNA8w7eIuBRUyWBYvJsC6CYWCwGGSy7bN6AOFn8 DwneJI/6mTYreNBryYl8A9KktTxoJfu0W66y3mSw6Q8pD+/LJNsWv6x5Z p6NbzJ/sF7uj/3Sf3OJqPUep6P0WnbObZfk1qu02zOks0spXylk+eUvOS 4v2g7x/bbSamPSecuqZ+p5TbN6inLvbcyma3azrH9Sr1IJyejQcq6yWL0 WqbTddspAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AANr0C5EmMYv5JZrpAAAAAElFTkSuQmCC</span></div><div><div html="<p>The icon image.</p>
<p><strong>Note:</strong></p>
<p>If you <strong>do not</strong> specify a value, the interface uses a standard puzzle piece icon.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The icon image.</p>
<p><strong>Note:</strong></p>
<p>If you <strong>do not</strong> specify a value, the interface uses a standard puzzle piece icon.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="group_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">group_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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"files"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"databases"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"domains"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"email"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"metrics"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"security"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"software"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"advanced"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"pref"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">group_id=advanced</span></div><div><div html="<p>The group ID in which to add the icon of the linked service.</p>
<ul>
<li><code>files</code></li>
<li><code>databases</code></li>
<li><code>domains</code></li>
<li><code>email</code></li>
<li><code>metrics</code></li>
<li><code>security</code></li>
<li><code>software</code></li>
<li><code>advanced</code></li>
<li><code>pref</code></li>
</ul>
<p><strong>Note:</strong></p>
<p>If you <strong>do not</strong> specify a value, the function automatically creates an item under the username menu in the interface header.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The group ID in which to add the icon of the linked service.</p>
<ul>
<li><code>files</code></li>
<li><code>databases</code></li>
<li><code>domains</code></li>
<li><code>email</code></li>
<li><code>metrics</code></li>
<li><code>security</code></li>
<li><code>software</code></li>
<li><code>advanced</code></li>
<li><code>pref</code></li>
</ul>
<p><strong>Note:</strong></p>
<p>If you <strong>do not</strong> specify a value, the function automatically creates an item under the username menu in the interface header.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="hide" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">hide</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">hide=1</span></div><div><div html="<p>Whether the cPanel interface will display the integration link.</p>
<ul>
<li><code>1</code> - Do <strong>not</strong> display the link.</li>
<li><code>0</code> - Display the link.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the cPanel interface will display the integration link.</p>
<ul>
<li><code>1</code> - Do <strong>not</strong> display the link.</li>
<li><code>0</code> - Display the link.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="implements" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">implements</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">implements=billing</span></div><div><div html="<p>The service for which to implement authentication.</p>
<p><strong>Note:</strong></p>
<p>This is a string from the <code>get_users_links</code> function. The function typically returns one of the following values.</p>
<ul>
<li><code>billing</code> - This link appears in the user menu</li>
<li><code>customer_service</code> - This link appears in the user menu</li>
<li><code>support</code> - This link appears in the user menu</li>
<li><code>upgrade</code> - This link appears in the user menu and context-sensitive areas when the user may require more of a resource</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service for which to implement authentication.</p>
<p><strong>Note:</strong></p>
<p>This is a string from the <code>get_users_links</code> function. The function typically returns one of the following values.</p>
<ul>
<li><code>billing</code> - This link appears in the user menu</li>
<li><code>customer_service</code> - This link appears in the user menu</li>
<li><code>support</code> - This link appears in the user menu</li>
<li><code>upgrade</code> - This link appears in the user menu and context-sensitive areas when the user may require more of a resource</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="label" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">label</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">label=WHMCS Billing</span></div><div><div html="<p>The label to display in the cPanel login interface.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The label to display in the cPanel login interface.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="order" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">order</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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=999</span></div><div><div html="<p>The order in which to display the icon in the cPanel interface inside the <code>group_id</code> group.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The order in which to display the icon in the cPanel interface inside the <code>group_id</code> group.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="subscriber_unique_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">subscriber_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">subscriber_unique_id=1234</span></div><div><div html="<p>The subscriber&#39;s unique ID that the system will present to the URL in the <code>autologin_token_url</code> endpoint.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The subscriber's unique ID that the system will present to the URL in the <code>autologin_token_url</code> endpoint.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="token" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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">token=subway</span></div><div><div html="<p>The token that the system will present to the URL in the <code>autologin_token_url</code> endpoint.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The token that the system will present to the URL in the <code>autologin_token_url</code> endpoint.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="url" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">url=http://www.example.com</span></div><div><div html="<p>The URL to which to send the user if the <code>autologin_token_url</code> location does not respond or is not present.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>must</strong> include either the <code>autologin_token_url</code> parameter, the <code>url</code> parameter, or both.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The URL to which to send the user if the <code>autologin_token_url</code> location does not respond or is not present.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>must</strong> include either the <code>autologin_token_url</code> parameter, the <code>url</code> parameter, or both.</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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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 cPanel account name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="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">/create_integration_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/create_integration_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:R4kil7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kil7q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kil7q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kil7q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kil7q:0" aria-labelledby="tab:R4kil7q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
create_integration_link <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">app</span><span class="token operator">=</span><span class="token string">'WHMCS_billing'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">token</span><span class="token operator">=</span><span class="token string">'subway'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">implements</span><span class="token operator">=</span><span class="token string">'billing'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">label</span><span class="token operator">=</span><span class="token string">'WHMCS Billing'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">subscriber_unique_id</span><span class="token operator">=</span><span class="token string">'1234'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kil7q:1" aria-labelledby="tab:R4kil7q: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:R4sil7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sil7q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sil7q:0" aria-labelledby="tab:R4sil7q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"create_integration_link"</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/Links/operation/get_integration_link_user_config" data-section-id="tag/Links/operation/get_integration_link_user_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_integration_link_user_config" id="operation/get_integration_link_user_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Links/operation/get_integration_link_user_config" aria-label="tag/Links/operation/get_integration_link_user_config"></a>Return integration link configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves configuration information about a specified integration link in a specified user&#39;s cPanel interface.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves configuration information about a specified integration link in a specified 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=""><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=WHMCS_billing</span></div><div><div html="<p>The integration link&#39;s app name.</p>
<p><strong>Warning:</strong></p>
<p>If you create a link with an app value that already exists, the function will replace the existing link with the newly-created link.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The integration link's app name.</p>
<p><strong>Warning:</strong></p>
<p>If you create a link with an app value that already exists, the function will replace the existing link with the newly-created link.</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=username</span></div><div><div html="<p>The cPanel account name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_integration_link_user_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_integration_link_user_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:R4kjl7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kjl7q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kjl7q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjl7q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kjl7q:0" aria-labelledby="tab:R4kjl7q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_integration_link_user_config <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">app</span><span class="token operator">=</span><span class="token string">'WHMCS_billing'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjl7q:1" aria-labelledby="tab:R4kjl7q: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:R4sjl7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sjl7q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sjl7q:0" aria-labelledby="tab:R4sjl7q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"userconfig"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"app"</span>: <span class="token string">"WHMCS_billing"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autologin_token_url"</span>: <span class="token string">"</span><a href="http://www.example.com/login.cgi">http://www.example.com/login.cgi</a><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">"iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABmJLR0QA%2fwD%2fAP%2bgvaeTAAAACXBIWXMAAABIAAAASABGyWs%2bAAALVUlEQVRo3sWZe3BU1R3HP79z793dZAPkBYIg4RUSBKkIEfCNog5WbaWOHevUWttOVXxVtFWctmpb2xGptVOt1ken1bbSVsVSxVba8UkrsRIxYhbRJEqRVxJCErK7d%2b89%2fePcTW6WTdj4mH5nLuTunj3n%2b%2f2d3%2fn9fucc4f%2bAbdu2ISJkMhmxbXupiMwH0lrr33qet7W6uhoRKaivwlp9TCQSCQAFVAEdwL7gqxLgCeB0wAOuSqVSvywvLyeZTIrWeqLWukdrvVcpRXV19UF9q0%2bbeEC%2bEvgOsA74EVAaNBkP1AR%2fW0BdNBq1enp68Dyvzvf9P2qtVwNn%2bb5vh%2frrg%2f1JEP3hG0ehROFpt8qW2CLAymRceax7aXeHv2PtFSM3LtD4NwNxYAqQAn4CnAwcFupqLjADiAG%2fAOqCz2PAq0Bb7tjDFrC8Pj7gfVVdD%2b3p9xAUoJcCKzGuKUCHhWyPSWmiV7fvCQQ4wGXAKcAEIBrqbibweMBrSujzt4HOfHwKEhAiXR5YqQHYs6quJ%2fSdHwGOxbgCGg8NZQp7zhGxyvu39rY3AJOCxkXAnDxDWcD0nM9c4AUgA1BTUzPgyyEFhIhHgcXA1cBC4DHgxuX18fZQ89HALNBEZRRTnDPo8rdLt79r4aaelx%2bLqzHJ%2fKMIAmjo%2bzePAA8oBiYlEok6YNf06dP%2f1tTUpAeNQiHyDnAT8C36F18G%2bBWwgv6pPQVYo9GjjopcxMLYcjxSpPzO9mI1%2bg1BzQ9IBLQVGk1ad%2bFyAIfiroiUKIyb5aIFeAeoBQ4HtsZisQs6OzsbC3EhDUwMkc%2fO3DeAJPCDYOoXa%2fTImIximrMECxtBcFRRuUYvClscNHu8LWxzn2Gn9wZJ3ZGptI788ZLiu193de%2fZwNKAaBaT6Hc%2fgFrP886ePXt2YyEzAPAV4EEOdrle4EWgDBM9RgiKGudc5seuJSalaPwca3i8nX6CTakH6dY7s6J2CNaSmJRtvnjEehs4HrgDs6YOgoisi0QiV2%2fdunXboHlgVV1P%2bPU1YGeeZkXAmcFAIwxBnyZ3DRuSK%2bnVbYRzpSAk3LX8O3UX3XoXgpV93qpQ1c0%2bKTDu%2bQJwObAlD%2flnIpHIsmQyuW3u3LkFJ7IWYHMhDTUaH49t7jr2eFtQwRCCYp%2ffQkPqYVx9IAi7Bgr7lRV7NnWNsWbj6TTj7em0%2bTteV9h3YnJGFp7jOGu6urqaa2trqaioMC4RcpdRmOy4HeiiPyz0AE3AWUORFxRFUspIdQSHWUdTYdUOcKGWzPN0%2bu8PII9xwzevLIe4jOXp3m8y0T3Bakg9UjbZXtxyYtGN7yjsWUFby%2fO8C%2bPx%2bIetra2NjuPsskPkFbAMuCIg%2b0rwvAXMAs4e2vI%2bY61jOD72bUaq8ThS0jcjAB5pdmU2o9G5BVjMx%2f16qapqas48l3b1gTm7M1tO8MksTLhrKqY4i9RE%2b8Q%2bQ3iet8jzvAWu625Pp9OvhRflvMDvxgfPqYHlWzERaPyhXKdYjabCmg6hyJ6dG1%2b7JPW%2bfNWjAGcmdftUjW8D4zV%2b1PTp0eE36ypOys0QRUC17%2fsVWQGxgPyEnI5LMOn9UOgE%2fVpMStuA00GPYkChqBGxsCWGJm8JrDR%2bbgZGUDgUDRYpXRFpywqIMzDuFooU8HfgXl%2b7G%2bZELvFdfWCuEmeuhXMccAZBdLKJUmnVpj7IvGwTlBtDQ%2bNInDJrygDrK6UaReRZy7I2KaW2ZK3Uhil3XxkG%2bX3AbcDFwLO2FO0%2fZsZJ3TEpewH4KfA1TAUZ0IGZkS82l8i4J0GnDtW5j88Y6ygqVE04EHiWZd3V2Nh4w6RJk35fVVXVoELxvgFTJb5QAPku4LuYynPfqrqeUN7QaDIIMh0YF7ZoiYydtLTkd42C%2fQDozOC29ymSCj4T%2bTIRKSG0nsTzvCPr6upKWltb0VobPw2JaAxE%2fHNI48B9wAOAm%2f3t9fUjeP6tPzDtzclYRI7TcD8560fjx4pl9GXnl6xuUTjrNV6YXF8OKZZKFsSu1RPs43IzufJ9%2f8re3t7bo9FoZSKR6F9oIRFNwBoGKQ2BTZjNxkFuMNk5jddnvlSpsG8Hna9cRuOPLVfTVpxVfE%2fZYdacdERGoLBROMRlNNOcM1lcfAc1zrmDLd6o53lX9Pb2XlpbW9tf24TyQTFwDPn3yz7wKPB%2bvp5TuoudXkPnFLV4k6BODozQhalYD6dvr%2bCXH24fO3%2bJVUOn%2fz69ug2Fwwg1jhFqAjbRXMt3iUiH1nosEBGRNqVU%2fcaNG5Hl9fEYZltXGxA%2fFrPVK8vDcTsmG7%2bZM2sALNsIN5R%2bSI%2b%2fZ5otsZtAvw%2b8hAkSq4DTBnYnCKrPUjpwoly7AN%2bLRCJPicg8z%2fNOFZF3y8rKVrqu69qYzUktJgcUM%2fRJxTuYxJYXcSmlyhlLqyvveiQvd%2fUBV7B0YPn%2f5nOoYOc2FHwgkU6nE8XFxYnKysrVqVRK2tra3KlTp2IDn6NwbMdk57y4o24fdxj9GkiHThAOx2T6MKn99O%2bRw%2bgJfl8SvBcBJ6TT6adEhO7u7syMGTP6Gis4lAEGoBuzvRsuZjFwQ%2fIc8HngZwR73QCtwCWYemxH6PP5kUikVGt90IGXzfAOt%2bIYdxiuiGbMmdASTHK7CuOOXZjN0pigXT2wVpC0RvuYdeMCT5Mn6mUFPI5ZAxMx0zaUoAmBiP3DFNAEXIoJDu8ET9bi74UEbBypJqT2egksia62sHcL0pEhtUlQnq0ieQVchDlRqMEcmdRhKtHyPESmB0IbC2GdcwSyH1gL0JRoQuOhsDs87f4ZdA%2bQFFEvZnSKh%2fefxF3HdmcwrjYk%2bqwdygNFwD3AV%2fO094DrgJ9nP8gNpYXipS2rcaSSlL%2fbsSTiaLT2dCoF%2bKfMvKjgfga4S0jEVcDd5HenesypwfaPI%2bCTQr5MfGRAcLC1MBezc%2fs%2bkB7ugME45cA5mFI7XxQUTPZ%2bGmgfylCSQ%2f4oTJ1z0iF47MeU3w8CmUJnIRhnJHArJlQ6Qwhwgd8IskKj9w4qIET%2bGIxvH1%2bgMTswJ8z3BYIGtVJojAnAzZiIFDnkCCZHPGpJ0Y31bXt33bdgPdUjF6Gkfz%2bUFVABrOagWuWQSAHPAPdi4ntXWEjQt2DuB04HrgTmM7x7CQ1q5Sljr1nx2t5HvFuObkak%2f%2bfZNdCFSTbDRRQ4D3MuWo%2fZ0TUtr493BsRHA7OBE4P%2fiz7CGK4Sq%2fmcv%2f7Qe%2bi089F6oMeFXWgeJqlN7FdONybRlGKuhwpBOngkEFjI%2bauHOYWLBOPEQuZ%2fTkn0wm63ve3eBT5KBk5euPP%2fYBbwMsyFwobgacTUMvfQfx00FCIU5t8hjqwFrg%2bEzMGsw4VAhSCrtN7fticJuw%2b0HPTj3Cg0ArOP3UF%2fVZjFncDyYRArFL2YauBJgJHOOErs0WpncktZxu%2bt8NEtvs6kF429lqVVd%2bUXMBhCwuLAnzDF2KeBW4Fbsi%2fDSY6FRoPJmEX4aeF4gvOj4WJQATn3A%2fMYeJuYRS%2bmTP4XQ1eouzAHYBvg4D0jJvtPBgbE%2bI8lIAQbk5lzo0kaE%2f8vBD6LqZ3yZdVOTNY9D%2bPr6%2fK0OYxBLjM%2bCQGCCaXhCz0XE5VuCwh2AP8g%2fyy0YCx%2fIPj7GmB9TptmYI8Su%2b80%2b2MLCC0kF3Pd8yVMcbUfeAiz8MKEtwEf5OmqAdgben8XU%2b0%2bD%2bzGXBZ%2bAfiLr93gzrJwFNQ6tB7KMHF6M7B34D0xEeDXgdAs%2fIDsvVmjhNpXY0qYTUDqo5blw72p7yB07Li8Ps6quh6uqy9GUGngVQ0X0D%2bz7YJuAOk77wkRDW8tPzIKEnAo60RVORErhq%2b9dUrsKIgjIL722l0%2fucVSDh2pDwoZatj4H%2bRdIAdHBVWZAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDE1LTA5LTAyVDEyOjM5OjQ4LTA1OjAwppVa9QAAACV0RVh0ZGF0ZTptb2RpZnkAMjAxNS0wOS0wMlQxMjozOTo0OC0wNTowMNfI4kkAAAAASUVORK5CYII%3d"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"implements"</span>: <span class="token string">"billing"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">"WHMCS Billing"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subscriber_unique_id"</span>: <span class="token string">"1234"</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.example.com">http://www.example.com</a><span class="token string">"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_integration_link_user_config"</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/Links/operation/list_integration_groups" data-section-id="tag/Links/operation/list_integration_groups" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_integration_groups" id="operation/list_integration_groups" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Links/operation/list_integration_groups" aria-label="tag/Links/operation/list_integration_groups"></a>Return integration link groups<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the groups of integration links in the cPanel interface.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the groups of integration links in 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><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=username</span></div><div><div html="<p>The cPanel account name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_integration_groups</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_integration_groups</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kkl7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kkl7q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kkl7q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kkl7q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kkl7q:0" aria-labelledby="tab:R4kkl7q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_integration_groups <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R4kkl7q:1" aria-labelledby="tab:R4kkl7q: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:R4skl7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4skl7q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4skl7q:0" aria-labelledby="tab:R4skl7q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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 "><button class="collapser" aria-label="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">"Group3"</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">"metadata"</span>: <button class="collapser" aria-label="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">"list_integration_groups"</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/Links/operation/list_integration_links" data-section-id="tag/Links/operation/list_integration_links" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_integration_links" id="operation/list_integration_links" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Links/operation/list_integration_links" aria-label="tag/Links/operation/list_integration_links"></a>Return integration links<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists integration links in the cPanel interface.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists integration links in 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><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><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=username</span></div><div><div html="<p>The cPanel account name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_integration_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_integration_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:R4kll7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kll7q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kll7q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kll7q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kll7q:0" aria-labelledby="tab:R4kll7q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_integration_links <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R4kll7q:1" aria-labelledby="tab:R4kll7q: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:R4sll7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sll7q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sll7q:0" aria-labelledby="tab:R4sll7q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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 "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"app"</span>: <span class="token string">"WHMCS_billing"</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">"metadata"</span>: <button class="collapser" aria-label="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">"list_integration_links"</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/Links/operation/remove_integration_group" data-section-id="tag/Links/operation/remove_integration_group" class="sc-dntaoT ceciOs"><div data-section-id="operation/remove_integration_group" id="operation/remove_integration_group" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Links/operation/remove_integration_group" aria-label="tag/Links/operation/remove_integration_group"></a>Remove integration link group<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This removes a group of integration links from the cPanel interface.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This removes a group of integration links 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><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="group_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">group_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">group_id=WHMCS</span></div><div><div html="<p>The group&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The group's ID.</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=username</span></div><div><div html="<p>The cPanel account name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><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="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">/remove_integration_group</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remove_integration_group</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kml7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kml7q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kml7q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kml7q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kml7q:0" aria-labelledby="tab:R4kml7q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remove_integration_group <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">group_id</span><span class="token operator">=</span><span class="token string">'WHMCS'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kml7q:1" aria-labelledby="tab:R4kml7q: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:R4sml7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sml7q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sml7q:0" aria-labelledby="tab:R4sml7q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"remove_integration_group"</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/Links/operation/remove_integration_link" data-section-id="tag/Links/operation/remove_integration_link" class="sc-dntaoT ceciOs"><div data-section-id="operation/remove_integration_link" id="operation/remove_integration_link" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Links/operation/remove_integration_link" aria-label="tag/Links/operation/remove_integration_link"></a>Remove integration link<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes an integration link from the cPanel interface.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes an integration link 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><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><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=WHMCS_billing</span></div><div><div html="<p>The name of the integration link to remove.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the integration link to remove.</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=username</span></div><div><div html="<p>The cPanel account name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><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="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">/remove_integration_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remove_integration_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:R4knl7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4knl7q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4knl7q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knl7q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4knl7q:0" aria-labelledby="tab:R4knl7q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remove_integration_link <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">app</span><span class="token operator">=</span><span class="token string">'WHMCS_billing'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knl7q:1" aria-labelledby="tab:R4knl7q: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:R4snl7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4snl7q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4snl7q:0" aria-labelledby="tab:R4snl7q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"remove_integration_link"</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/Links/operation/update_integration_link_token" data-section-id="tag/Links/operation/update_integration_link_token" class="sc-dntaoT ceciOs"><div data-section-id="operation/update_integration_link_token" id="operation/update_integration_link_token" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Links/operation/update_integration_link_token" aria-label="tag/Links/operation/update_integration_link_token"></a>Update integration link token<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function refreshes the token for an integration link.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function refreshes the token for an integration 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=""><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=WHMCS_billing</span></div><div><div html="<p>The name of the application to link.</p>
<p><strong>Note:</strong></p>
<p> To update the name of the application in the interface, you <strong>must</strong> delete it and then recreate it with WHM API 1&#39;s <code>create_integration_link</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the application to link.</p>
<p><strong>Note:</strong></p>
<p> To update the name of the application in the interface, you <strong>must</strong> delete it and then recreate it with WHM API 1's <code>create_integration_link</code> function.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="token" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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">token=subway</span></div><div><div html="<p>The new access token to use for the application.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new access token to use for the application.</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 cPanel account name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><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="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">/update_integration_link_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/update_integration_link_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:R4kol7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kol7q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kol7q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kol7q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kol7q:0" aria-labelledby="tab:R4kol7q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
update_integration_link_token <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">app</span><span class="token operator">=</span><span class="token string">'WHMCS_billing'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">token</span><span class="token operator">=</span><span class="token string">'subway'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kol7q:1" aria-labelledby="tab:R4kol7q: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:R4sol7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sol7q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sol7q:0" aria-labelledby="tab:R4sol7q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"update_integration_link_token"</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/Scripts-Hooks" data-section-id="tag/Scripts-Hooks" 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/Scripts-Hooks" aria-label="tag/Scripts-Hooks"></a>Scripts Hooks</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Integrations / Scripts Hooks</p>
"><p>Integrations / Scripts Hooks</p>
</div></div></div><div id="tag/Scripts-Hooks/operation/edit_hook" data-section-id="tag/Scripts-Hooks/operation/edit_hook" class="sc-dntaoT ceciOs"><div data-section-id="operation/edit_hook" id="operation/edit_hook" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Scripts-Hooks/operation/edit_hook" aria-label="tag/Scripts-Hooks/operation/edit_hook"></a>Update script hook<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function edits a script hook.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function edits a script hook.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">check</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">check=/scripts/postcourier-authlibup</span></div><div><div html="<p>The absolute file path to the script that runs after the hook script to check the results.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute file path to the script that runs after the hook script to check the results.</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=TestHook</span></div><div><div html="<p>The hook script&#39;s description.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hook script's description.</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"> <!-- -->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 the hook script is enabled.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the hook script is enabled.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="exectype" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">exectype</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"script"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"module"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">exectype=script</span></div><div><div html="<p>The type of function that the script hook launches.</p>
<ul>
<li><code>script</code> — Runs a script.</li>
<li><code>module</code> — Calls a function in a module.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of function that the script hook launches.</p>
<ul>
<li><code>script</code> — Runs a script.</li>
<li><code>module</code> — Calls a function in a module.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="hook" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">hook</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">hook=/scripts/postcourier-authlibup</span></div><div><div html="<p>The hook script&#39;s absolute file path or its <code>module::subroutine</code> invocation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hook script's absolute file path or its <code>module::subroutine</code> invocation.</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=HzEpGvT6QGUYwxuX3hWB8AUq</span></div><div><div html="<p>The script hook&#39;s ID.</p>
<p><strong>Note:</strong></p>
<p>To retrieve a hook&#39;s ID, use the WHM API 1 <code>list_hooks</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The script hook's ID.</p>
<p><strong>Note:</strong></p>
<p>To retrieve a hook's ID, use the WHM API 1 <code>list_hooks</code> function.</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=Note.</span></div><div><div html="<p>The script hook&#39;s notes.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The script hook's notes.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="rollback" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">rollback</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rollback=/scripts/postcourier-authlibup</span></div><div><div html="<p>The absolute file path to the script that rolls back the hook script.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute file path to the script that rolls back the hook script.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="stage" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">stage</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"pre"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"post"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">stage=post</span></div><div><div html="<p>The condition when the hook script executes.</p>
<ul>
<li><code>pre</code> — The script runs before the function.</li>
<li><code>post</code> — The script runs after the function.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The condition when the hook script executes.</p>
<ul>
<li><code>pre</code> — The script runs before the function.</li>
<li><code>post</code> — The script runs after the function.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="weight" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">weight</span></td><td class="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">weight=100</span></div><div><div html="<p>The script hook&#39;s priority in the hook&#39;s stage, where a lower value runs before a higher value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The script hook's priority in the hook's stage, where a lower value runs before a higher 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="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">/edit_hook</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/edit_hook</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9n7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9n7q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9n7q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9n7q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9n7q:0" aria-labelledby="tab:R2a9n7q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
edit_hook <span class="token punctuation">\</span>
<span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'HzEpGvT6QGUYwxuX3hWB8AUq'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9n7q:1" aria-labelledby="tab:R2a9n7q: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:R2e9n7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9n7q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9n7q:0" aria-labelledby="tab:R2e9n7q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"edit_hook"</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/Scripts-Hooks/operation/list_hooks" data-section-id="tag/Scripts-Hooks/operation/list_hooks" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_hooks" id="operation/list_hooks" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Scripts-Hooks/operation/list_hooks" aria-label="tag/Scripts-Hooks/operation/list_hooks"></a>Return script hooks list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the server&#39;s script hooks.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the server's script hooks.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_hooks</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_hooks</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aan7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aan7q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aan7q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aan7q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aan7q:0" aria-labelledby="tab:R2aan7q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_hooks
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aan7q:1" aria-labelledby="tab:R2aan7q: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:R2ean7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ean7q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ean7q:0" aria-labelledby="tab:R2ean7q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"categories"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"category"</span>: <span class="token string">"RPM::Versions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"events"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"event"</span>: <span class="token string">"MariaDB-server"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stage_order"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"pre"</span>,</div></li><li><div class="hoverable "><span class="token string">"post"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"blocking"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"category"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"check"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"escalateprivs"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"event"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exectype"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hook"</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 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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stage"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"weight"</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">"attributes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"blocking"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"escalateprivs"</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">"description"</span>: <span class="token string">"My hook script."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stage"</span>: <span class="token string">"post"</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></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"list_hooks"</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/Scripts-Hooks/operation/delete_hook" data-section-id="tag/Scripts-Hooks/operation/delete_hook" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_hook" id="operation/delete_hook" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Scripts-Hooks/operation/delete_hook" aria-label="tag/Scripts-Hooks/operation/delete_hook"></a>Delete script hook<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes a script hook.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a script hook.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=HzEpGvT6QGUYwxuX3hWB8AUq</span></div><div><div html="<p>The script hook&#39;s ID.</p>
<p><strong>Note:</strong></p>
<p>To retrieve a hook&#39;s ID, use the WHM API 1 <code>list_hooks</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The script hook's ID.</p>
<p><strong>Note:</strong></p>
<p>To retrieve a hook's ID, use the WHM API 1 <code>list_hooks</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="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">/delete_hook</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/delete_hook</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abn7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abn7q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abn7q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abn7q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abn7q:0" aria-labelledby="tab:R2abn7q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
delete_hook <span class="token punctuation">\</span>
<span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'HzEpGvT6QGUYwxuX3hWB8AUq'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abn7q:1" aria-labelledby="tab:R2abn7q: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:R2ebn7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebn7q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebn7q:0" aria-labelledby="tab:R2ebn7q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"delete_hook"</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/Scripts-Hooks/operation/reorder_hooks" data-section-id="tag/Scripts-Hooks/operation/reorder_hooks" class="sc-dntaoT ceciOs"><div data-section-id="operation/reorder_hooks" id="operation/reorder_hooks" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Scripts-Hooks/operation/reorder_hooks" aria-label="tag/Scripts-Hooks/operation/reorder_hooks"></a>Update script hooks order<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function changes the order of script hooks.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes the order of script hooks.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="ids" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ids</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ids=HzEpGvT6QGUYwxuX3hWB8AUq,UNs8a8IbbAVf5oi_hXbcEw5a</span></div><div><div html="<p>A comma-seprated list of script hook IDs, in order of priority.</p>
<p><strong>Note:</strong></p>
<p>To retrieve a hook&#39;s ID, use the WHM API 1 <code>list_hooks</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-seprated list of script hook IDs, in order of priority.</p>
<p><strong>Note:</strong></p>
<p>To retrieve a hook's ID, use the WHM API 1 <code>list_hooks</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/reorder_hooks</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/reorder_hooks</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acn7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acn7q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acn7q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acn7q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acn7q:0" aria-labelledby="tab:R2acn7q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
reorder_hooks <span class="token punctuation">\</span>
<span class="token assign-left variable">ids</span><span class="token operator">=</span><span class="token string">'HzEpGvT6QGUYwxuX3hWB8AUq,UNs8a8IbbAVf5oi_hXbcEw5a'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acn7q:1" aria-labelledby="tab:R2acn7q: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:R2ecn7q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecn7q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecn7q:0" aria-labelledby="tab:R2ecn7q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"hook_order"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"HzEpGvT6QGUYwxuX3hWB8AUq"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"weight"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"UNs8a8IbbAVf5oi_hXbcEw5a"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"weight"</span>: <span class="token number">200</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">"metadata"</span>: <button class="collapser" aria-label="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">"reorder_hooks"</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/IPv4-Address-Settings" data-section-id="tag/IPv4-Address-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/IPv4-Address-Settings" aria-label="tag/IPv4-Address-Settings"></a>IPv4 Address Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>IP Address Management / IPv4 Address Settings</p>
"><p>IP Address Management / IPv4 Address Settings</p>
</div></div></div><div id="tag/IPv4-Address-Settings/operation/addips" data-section-id="tag/IPv4-Address-Settings/operation/addips" class="sc-dntaoT ceciOs"><div data-section-id="operation/addips" id="operation/addips" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/IPv4-Address-Settings/operation/addips" aria-label="tag/IPv4-Address-Settings/operation/addips"></a>Add IP addresses<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds an IPv4 address or addresses to the server.
When you add an IP address, the system attempts to add an alias of that IP
address to the main network interface. This process rebuilds the IP address
pool, which resides in the <code>/etc/ipaddrpool</code> file. The system stores IP addresses
within the <code>/etc/ips</code> file. The <code>ipaliases</code> service activates those IP addresses
when the server starts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds an IPv4 address or addresses to the server.
When you add an IP address, the system attempts to add an alias of that IP
address to the main network interface. This process rebuilds the IP address
pool, which resides in the <code>/etc/ipaddrpool</code> file. The system stores IP addresses
within the <code>/etc/ips</code> file. The <code>ipaliases</code> service activates those IP addresses
when the server starts.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="excludes" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">excludes</span></td><td class="sc-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">excludes=excludes=192.0.20.0,192.0.20.1</span> -<!-- --> <!-- -->Multiple IP addresses.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">excludes=192.0.20.0</span> -<!-- --> <!-- -->A single IP address.</li></ul><div><div html="<p>An IPv4 address or comma-delimited list of IPv4 addresses to exclude.</p>
<p><strong>Note:</strong></p>
<p>If you do not specify a value,
the function does not exclude any IPv4 addresses.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An IPv4 address or comma-delimited list of IPv4 addresses to exclude.</p>
<p><strong>Note:</strong></p>
<p>If you do not specify a value,
the function does not exclude any IPv4 addresses.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="ips" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ips</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-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">ips=192.168.0.0</span> -<!-- --> <!-- -->IPv4 address</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ips=192.168.0.20/28</span> -<!-- --> <!-- -->IPv4 address range</li></ul><div><div html="<p>The IPv4 address or address range
in <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Class C CIDR format</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPv4 address or address range
in <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Class C CIDR format</a>.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="netmask" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">netmask</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">netmask=255.255.255.0</span></div><div><div html="<p>The IPv4 address&#39; netmask.</p>
<p><strong>Note:</strong></p>
<p>If the <code>ips</code> parameter is in Class C CIDR format,
the range mask <strong>must</strong> be a value from <code>24</code> through <code>30</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPv4 address' netmask.</p>
<p><strong>Note:</strong></p>
<p>If the <code>ips</code> parameter is in Class C CIDR format,
the range mask <strong>must</strong> be a value from <code>24</code> through <code>30</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="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">/addips</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/addips</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9j8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9j8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9j8a:0" aria-labelledby="tab:R2a9j8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
addips <span class="token punctuation">\</span>
<span class="token assign-left variable">ips</span><span class="token operator">=</span><span class="token string">'192.168.0.0'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">netmask</span><span class="token operator">=</span><span class="token string">'255.255.255.0'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j8a:1" aria-labelledby="tab:R2a9j8a: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:R2e9j8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9j8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9j8a:0" aria-labelledby="tab:R2e9j8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"addips"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"eth0:cp1 is now up. 192.168.0.20/255.255.255.0 broadcast 192.168.0.255 has been added."</span></div></li></ul><span class="token punctuation">]</span></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">"Success"</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/IPv4-Address-Settings/operation/delip" data-section-id="tag/IPv4-Address-Settings/operation/delip" class="sc-dntaoT ceciOs"><div data-section-id="operation/delip" id="operation/delip" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/IPv4-Address-Settings/operation/delip" aria-label="tag/IPv4-Address-Settings/operation/delip"></a>Remove IP address<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes an IP address from the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes an IP address from the 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="ethernetdev" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ethernetdev</span></td><td 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">""</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ethernetdev=eth0</span></div><div><div html="<p>The network alias to which the IPv4 address is bound.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The network alias to which the IPv4 address is bound.</p>
</div></div></div></td></tr><tr class=""><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><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">ip=10.1.1.1</span></div><div><div html="<p>The IPv4 address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPv4 address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="skipifshutdown" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipifshutdown</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">skipifshutdown=1</span></div><div><div html="<p>Whether to remove the IP address if the ethernet interface is down.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> remove the IP address.</li>
<li><code>0</code> — Remove the IP address.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to remove the IP address if the ethernet interface is down.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> remove the IP address.</li>
<li><code>0</code> — Remove the 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="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">/delip</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/delip</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aaj8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aaj8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aaj8a:0" aria-labelledby="tab:R2aaj8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
delip <span class="token punctuation">\</span>
<span class="token assign-left variable">ip</span><span class="token operator">=</span><span class="token string">'10.1.1.1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj8a:1" aria-labelledby="tab:R2aaj8a: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:R2eaj8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eaj8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eaj8a:0" aria-labelledby="tab:R2eaj8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"delip"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"eth0:cp2 is now down, 10.1.1.1 has been removed"</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/IPv4-Address-Settings/operation/get_shared_ip" data-section-id="tag/IPv4-Address-Settings/operation/get_shared_ip" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_shared_ip" id="operation/get_shared_ip" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/IPv4-Address-Settings/operation/get_shared_ip" aria-label="tag/IPv4-Address-Settings/operation/get_shared_ip"></a>Return shared IP address<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the IP address that an account shares with the accounts that it owns.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the IP address that an account shares with the accounts that it 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="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=example</span></div><div><div html="<p>The WHM user&#39;s username.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the currently-authenticated user.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WHM user's username.</p>
<p><strong>Note:</strong></p>
<p>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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_shared_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_shared_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:R2abj8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abj8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abj8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abj8a:0" aria-labelledby="tab:R2abj8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_shared_ip
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj8a:1" aria-labelledby="tab:R2abj8a: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:R2ebj8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebj8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebj8a:0" aria-labelledby="tab:R2ebj8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"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">"metadata"</span>: <button class="collapser" aria-label="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">"get_shared_ip"</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/IPv4-Address-Settings/operation/listips" data-section-id="tag/IPv4-Address-Settings/operation/listips" class="sc-dntaoT ceciOs"><div data-section-id="operation/listips" id="operation/listips" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/IPv4-Address-Settings/operation/listips" aria-label="tag/IPv4-Address-Settings/operation/listips"></a>Return server's IP addresses<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists a server&#39;s IP addresses.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a server's IP 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/listips</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/listips</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acj8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acj8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acj8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acj8a:0" aria-labelledby="tab:R2acj8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
listips
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj8a:1" aria-labelledby="tab:R2acj8a: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:R2ecj8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecj8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecj8a:0" aria-labelledby="tab:R2ecj8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ip"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"dedicated"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"if"</span>: <span class="token string">"eth0"</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.20"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mainaddr"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"netmask"</span>: <span class="token string">"255.255.0.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"network"</span>: <span class="token string">"192.168.0.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"public_ip"</span>: <span class="token string">"10.1.32.177"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"removable"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</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">"metadata"</span>: <button class="collapser" aria-label="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">"listips"</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/IPv4-Address-Settings/operation/setsiteip" data-section-id="tag/IPv4-Address-Settings/operation/setsiteip" class="sc-dntaoT ceciOs"><div data-section-id="operation/setsiteip" id="operation/setsiteip" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/IPv4-Address-Settings/operation/setsiteip" aria-label="tag/IPv4-Address-Settings/operation/setsiteip"></a>Update domain or cPanel account IP address<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function changes a site&#39;s or account&#39;s IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes a site's or account's 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=""><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&#39;s name.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> use either the <code>user</code> parameter or <code>domain</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain's name.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> use either the <code>user</code> parameter or <code>domain</code> parameter.</p>
</div></div></div></td></tr><tr class=""><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><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">ip=192.168.4.10</span></div><div><div html="<p>The site&#39;s or user&#39;s IPv4 address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The site's or user's IPv4 address.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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=username</span></div><div><div html="<p>The user&#39;s username.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> use either the <code>user</code> parameter or <code>domain</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user's username.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> use either the <code>user</code> parameter or <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="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">/setsiteip</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/setsiteip</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adj8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adj8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adj8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adj8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adj8a:0" aria-labelledby="tab:R2adj8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
setsiteip <span class="token punctuation">\</span>
<span class="token assign-left variable">ip</span><span class="token operator">=</span><span class="token string">'192.168.4.10'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adj8a:1" aria-labelledby="tab:R2adj8a: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:R2edj8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edj8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edj8a:0" aria-labelledby="tab:R2edj8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"setsiteip"</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/IPv6-Address-Settings" data-section-id="tag/IPv6-Address-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/IPv6-Address-Settings" aria-label="tag/IPv6-Address-Settings"></a>IPv6 Address Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>IP Address Management / IPv6 Address Settings</p>
"><p>IP Address Management / IPv6 Address Settings</p>
</div></div></div><div id="tag/IPv6-Address-Settings/operation/ipv6_enable_account" data-section-id="tag/IPv6-Address-Settings/operation/ipv6_enable_account" class="sc-dntaoT ceciOs"><div data-section-id="operation/ipv6_enable_account" id="operation/ipv6_enable_account" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/IPv6-Address-Settings/operation/ipv6_enable_account" aria-label="tag/IPv6-Address-Settings/operation/ipv6_enable_account"></a>Add IPv6 address range to accounts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function assigns an IPv6 address to one or more accounts.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> perform at least one of the following actions before you call this function:</p>
<ul>
<li>Use WHM&#39;s <a href="https://go.cpanel.net/whmdocsIPv6Ranges"><em>IPv6 Ranges</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; IP Functions &gt;&gt; IPv6 Ranges</em>) or WHM API 1&#39;s <code>ipv6_range_add</code> function to add one or more IPv6 address ranges for use as dedicated IPv6 addresses.</li>
<li>Use WHM&#39;s <a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup"><em>Basic WebHost Manager Setup</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Basic WebHost Manager Setup</em>) or modify the <a href="https://go.cpanel.net/advancedinstall"><code>/etc/wwwacct.conf</code></a> file to add a shared IPv6 address to the server.</li>
<li>For all of cPanel &amp; WHM&#39;s features to function properly on IPv6, the <code>cpsrvd</code> daemon <strong>must</strong> listen on IPv6 addresses. To enable this functionality, select <em>On</em> for the <em>Listen on IPv6 Addresses</em> setting in the <em>System</em> section of WHM&#39;s <a href="https://go.cpanel.net/whmdocsTweakSettings#system"><em>Tweak Settings</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>).</li>
</ul>
<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 assigns an IPv6 address to one or more accounts.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> perform at least one of the following actions before you call this function:</p>
<ul>
<li>Use WHM's <a href="https://go.cpanel.net/whmdocsIPv6Ranges"><em>IPv6 Ranges</em></a> interface (<em>WHM >> Home >> IP Functions >> IPv6 Ranges</em>) or WHM API 1's <code>ipv6_range_add</code> function to add one or more IPv6 address ranges for use as dedicated IPv6 addresses.</li>
<li>Use WHM's <a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup"><em>Basic WebHost Manager Setup</em></a> interface (<em>WHM >> Home >> Server Configuration >> Basic WebHost Manager Setup</em>) or modify the <a href="https://go.cpanel.net/advancedinstall"><code>/etc/wwwacct.conf</code></a> file to add a shared IPv6 address to the server.</li>
<li>For all of cPanel & WHM's features to function properly on IPv6, the <code>cpsrvd</code> daemon <strong>must</strong> listen on IPv6 addresses. To enable this functionality, select <em>On</em> for the <em>Listen on IPv6 Addresses</em> setting in the <em>System</em> section of WHM's <a href="https://go.cpanel.net/whmdocsTweakSettings#system"><em>Tweak Settings</em></a> interface (<em>WHM >> Home >> Server Configuration >> Tweak Settings</em>).</li>
</ul>
<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=""><td kind="field" title="range" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">range</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">range=Hosting_IPv6_Block</span></div><div><div html="<p>The IPv6 address range&#39;s name.</p>
<p><strong>Note:</strong></p>
<p>The range name <code>SHARED</code> will assign the server&#39;s shared IPv6 address to the account(s).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPv6 address range's name.</p>
<p><strong>Note:</strong></p>
<p>The range name <code>SHARED</code> will assign the server's shared IPv6 address to the account(s).</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=user1,user2,user3</span></div><div><div html="<p>A comma-delimited list of account names.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-delimited list of account names.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ipv6_enable_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ipv6_enable_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:R4khl8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4khl8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4khl8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4khl8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4khl8a:0" aria-labelledby="tab:R4khl8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
ipv6_enable_account <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'user1,user2,user3'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">range</span><span class="token operator">=</span><span class="token string">'Hosting_IPv6_Block'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4khl8a:1" aria-labelledby="tab:R4khl8a: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:R4shl8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4shl8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4shl8a:0" aria-labelledby="tab:R4shl8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fail_cnt"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><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="obj collapsible"><li><div class="hoverable "><span class="property token string">"brain"</span>: <span class="token string">"The “brain” account does not exist."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pinky"</span>: <span class="token string">"The “pinky” account does not exist."</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ipv6"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"chewie"</span>: <span class="token string">"2001:0db8:1a34:56cf:0000:0000:0000:0000"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cptest"</span>: <span class="token string">"2001:0db8:1a34:56cf:0000:0000:0000:0001"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain1"</span>: <span class="token string">"2001:0db8:1a34:56cf:0000:0000:0000:0002"</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"ipv6_enable_account"</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/IPv6-Address-Settings/operation/ipv6_disable_account" data-section-id="tag/IPv6-Address-Settings/operation/ipv6_disable_account" class="sc-dntaoT ceciOs"><div data-section-id="operation/ipv6_disable_account" id="operation/ipv6_disable_account" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/IPv6-Address-Settings/operation/ipv6_disable_account" aria-label="tag/IPv6-Address-Settings/operation/ipv6_disable_account"></a>Remove IPv6 address range from account<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes the IPv6 address from an account.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>When you disable IPv6 on an account, the system unbinds that IPv6 address from your server and the account loses the address. If you enable IPv6 on that account again, the system assigns it a different IPv6 address.</li>
<li>For all of cPanel &amp; WHM&#39;s features to function properly on IPv6, the <code>cpsrvd</code> daemon <strong>must</strong> listen on IPv6 addresses. To enable this functionality, select On for the <em>Listen on IPv6 Addresses</em> setting in the <em>System</em> section of WHM&#39;s <a href="https://go.cpanel.net/whmdocsTweakSettings">Tweak Settings</a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>).</li>
</ul>
<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 removes the IPv6 address from an account.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>When you disable IPv6 on an account, the system unbinds that IPv6 address from your server and the account loses the address. If you enable IPv6 on that account again, the system assigns it a different IPv6 address.</li>
<li>For all of cPanel & WHM's features to function properly on IPv6, the <code>cpsrvd</code> daemon <strong>must</strong> listen on IPv6 addresses. To enable this functionality, select On for the <em>Listen on IPv6 Addresses</em> setting in the <em>System</em> section of WHM's <a href="https://go.cpanel.net/whmdocsTweakSettings">Tweak Settings</a> interface (<em>WHM >> Home >> Server Configuration >> Tweak Settings</em>).</li>
</ul>
<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="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=user1,user2,user3</span></div><div><div html="<p>A comma delimited list of account names.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma delimited list of account names.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ipv6_disable_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ipv6_disable_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:R4kil8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kil8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kil8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kil8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kil8a:0" aria-labelledby="tab:R4kil8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
ipv6_disable_account <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'user1,user2,user3'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kil8a:1" aria-labelledby="tab:R4kil8a: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:R4sil8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sil8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sil8a:0" aria-labelledby="tab:R4sil8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fail_cnt"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><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">"name"</span>: <span class="token string">"user1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"The “user1” account does not exist."</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">"metadata"</span>: <button class="collapser" aria-label="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">"ipv6_disable_account"</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/IPv6-Address-Settings/operation/ipv6_range_add" data-section-id="tag/IPv6-Address-Settings/operation/ipv6_range_add" class="sc-dntaoT ceciOs"><div data-section-id="operation/ipv6_range_add" id="operation/ipv6_range_add" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/IPv6-Address-Settings/operation/ipv6_range_add" aria-label="tag/IPv6-Address-Settings/operation/ipv6_range_add"></a>Add IPv6 address range<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds a range of IPv6 addresses to the server.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>This function <strong>cannot</strong> modify the server&#39;s shared IPv6 address. To update that address, modify the <a href="https://go.cpanel.net/advancedinstall">/etc/wwwacct.conf</a> file, or use WHM&#39;s <a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup"><em>Basic WebHost Manager Setup</em></a> interface (<em>Home &gt;&gt; Server Configuration &gt;&gt; Basic WebHost Manager Setup</em>).</li>
<li>For all of cPanel &amp; WHM&#39;s features to function properly on IPv6, the <code>cpsrvd</code> daemon <strong>must</strong> listen on IPv6 addresses. To enable this functionality, select <em>On</em> for the <em>Listen on IPv6 Addresses</em> setting in the <a href="https://go.cpanel.net/whmdocsTweakSettings#system"><em>System</em></a> section of WHM&#39;s <a href="https://go.cpanel.net/whmdocsTweakSettings"><em>Tweak Settings</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>).</li>
</ul>
<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 adds a range of IPv6 addresses to the server.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>This function <strong>cannot</strong> modify the server's shared IPv6 address. To update that address, modify the <a href="https://go.cpanel.net/advancedinstall">/etc/wwwacct.conf</a> file, or use WHM's <a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup"><em>Basic WebHost Manager Setup</em></a> interface (<em>Home >> Server Configuration >> Basic WebHost Manager Setup</em>).</li>
<li>For all of cPanel & WHM's features to function properly on IPv6, the <code>cpsrvd</code> daemon <strong>must</strong> listen on IPv6 addresses. To enable this functionality, select <em>On</em> for the <em>Listen on IPv6 Addresses</em> setting in the <a href="https://go.cpanel.net/whmdocsTweakSettings#system"><em>System</em></a> section of WHM's <a href="https://go.cpanel.net/whmdocsTweakSettings"><em>Tweak Settings</em></a> interface (<em>WHM >> Home >> Server Configuration >> Tweak Settings</em>).</li>
</ul>
<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=""><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 the IPv6 address range is available.</p>
<p><strong>Note</strong></p>
<ul>
<li><code>1</code> - Available.</li>
<li><code>0</code> - Reserved.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the IPv6 address range is available.</p>
<p><strong>Note</strong></p>
<ul>
<li><code>1</code> - Available.</li>
<li><code>0</code> - Reserved.</li>
</ul>
</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=ExampleRange</span></div><div><div html="<p>The IPv6 address range&#39;s name.</p>
<p><strong>Note:</strong></p>
<p>You <strong>cannot</strong> use SHARED as a range&#39;s name.
It is reserved for the server&#39;s shared IPv6 address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPv6 address range's name.</p>
<p><strong>Note:</strong></p>
<p>You <strong>cannot</strong> use SHARED as a range's name.
It is reserved for the server's shared IPv6 address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="note" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">note</span></td><td 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">note=Initial IPv6 address pool</span></div><div><div html="<p>A note for the IPv6 address range.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A note for the IPv6 address range.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="range" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">range</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">range=2001:db8:66ac:cafe::/64</span></div><div><div html="<p>The IPv6 address range and network portion
in <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">CIDR format</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPv6 address range and network portion
in <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">CIDR format</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="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">/ipv6_range_add</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ipv6_range_add</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kjl8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kjl8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kjl8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjl8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kjl8a:0" aria-labelledby="tab:R4kjl8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
ipv6_range_add <span class="token punctuation">\</span>
<span class="token assign-left variable">range</span><span class="token operator">=</span><span class="token string">'2001:db8:66ac:cafe::/64'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'ExampleRange'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjl8a:1" aria-labelledby="tab:R4kjl8a: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:R4sjl8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sjl8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sjl8a:0" aria-labelledby="tab:R4sjl8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"ipv6_range_add"</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/IPv6-Address-Settings/operation/ipv6_range_edit" data-section-id="tag/IPv6-Address-Settings/operation/ipv6_range_edit" class="sc-dntaoT ceciOs"><div data-section-id="operation/ipv6_range_edit" id="operation/ipv6_range_edit" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/IPv6-Address-Settings/operation/ipv6_range_edit" aria-label="tag/IPv6-Address-Settings/operation/ipv6_range_edit"></a>Update IPv6 address range name or note<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function changes an IPv6 address range&#39;s name and/or note.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>This function <strong>cannot</strong> modify the server&#39;s shared IPv6 address. To update that address, modify the <a href="https://go.cpanel.net/advancedinstall">/etc/wwwacct.conf</a> file, or use WHM&#39;s <a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup"><em>Basic WebHost Manager Setup</em></a> interface (<em>Home &gt;&gt; Server Configuration &gt;&gt; Basic WebHost Manager Setup</em>).</li>
<li>For all of cPanel &amp; WHM&#39;s features to function properly on IPv6, the <code>cpsrvd</code> daemon <strong>must</strong> listen on IPv6 addresses. To enable this functionality, select <em>On</em> for the <em>Listen on IPv6 Addresses</em> setting in the <a href="https://go.cpanel.net/whmdocsTweakSettings#system"><em>System</em></a> section of WHM&#39;s <a href="https://go.cpanel.net/whmdocsTweakSettings"><em>Tweak Settings</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>).</li>
</ul>
<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 changes an IPv6 address range's name and/or note.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>This function <strong>cannot</strong> modify the server's shared IPv6 address. To update that address, modify the <a href="https://go.cpanel.net/advancedinstall">/etc/wwwacct.conf</a> file, or use WHM's <a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup"><em>Basic WebHost Manager Setup</em></a> interface (<em>Home >> Server Configuration >> Basic WebHost Manager Setup</em>).</li>
<li>For all of cPanel & WHM's features to function properly on IPv6, the <code>cpsrvd</code> daemon <strong>must</strong> listen on IPv6 addresses. To enable this functionality, select <em>On</em> for the <em>Listen on IPv6 Addresses</em> setting in the <a href="https://go.cpanel.net/whmdocsTweakSettings#system"><em>System</em></a> section of WHM's <a href="https://go.cpanel.net/whmdocsTweakSettings"><em>Tweak Settings</em></a> interface (<em>WHM >> Home >> Server Configuration >> Tweak Settings</em>).</li>
</ul>
<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=""><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=ExampleRange</span></div><div><div html="<p>The IPv6 address range&#39;s current name.</p>
<p><strong>Note:</strong></p>
<p>You <strong>cannot</strong> edit the range named SHARED.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPv6 address range's current name.</p>
<p><strong>Note:</strong></p>
<p>You <strong>cannot</strong> edit the range named SHARED.</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"> <!-- -->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">new_name=AnotherRange</span></div><div><div html="<p>The IPv6 address range&#39;s new name.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If not supplied the range keeps its old name.</li>
<li>You <strong>cannot</strong> change range name to SHARED.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPv6 address range's new name.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If not supplied the range keeps its old name.</li>
<li>You <strong>cannot</strong> change range name to SHARED.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">note=This is an update to the note.</span></div><div><div html="<p>The IPv6 address range&#39;s new note.</p>
<p><strong>Note:</strong></p>
<p>If you don&#39;t specify this parameter, the function will not change the range&#39;s note.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPv6 address range's new note.</p>
<p><strong>Note:</strong></p>
<p>If you don't specify this parameter, the function will not change the range's note.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/ipv6_range_edit</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ipv6_range_edit</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kkl8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kkl8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kkl8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kkl8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kkl8a:0" aria-labelledby="tab:R4kkl8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
ipv6_range_edit <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'ExampleRange'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kkl8a:1" aria-labelledby="tab:R4kkl8a: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:R4skl8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4skl8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4skl8a:0" aria-labelledby="tab:R4skl8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"ipv6_range_edit"</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/IPv6-Address-Settings/operation/ipv6_range_usage" data-section-id="tag/IPv6-Address-Settings/operation/ipv6_range_usage" class="sc-dntaoT ceciOs"><div data-section-id="operation/ipv6_range_usage" id="operation/ipv6_range_usage" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/IPv6-Address-Settings/operation/ipv6_range_usage" aria-label="tag/IPv6-Address-Settings/operation/ipv6_range_usage"></a>Return IPv6 address usage<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves usage information for IPv6 addresses in an IPv6 range.</p>
<p><strong>Note:</strong></p>
<p>For all of cPanel &amp; WHM&#39;s features to function properly on IPv6, the <code>cpsrvd</code> daemon <strong>must</strong> listen on IPv6 addresses. To enable this functionality, select <em>On</em> for the <em>Listen on IPv6 Addresses</em> setting in the <a href="https://go.cpanel.net/whmdocsTweakSettings#system"><em>System</em></a> section of WHM&#39;s <a href="https://go.cpanel.net/whmdocsTweakSettings"><em>Tweak Settings</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>).</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 retrieves usage information for IPv6 addresses in an IPv6 range.</p>
<p><strong>Note:</strong></p>
<p>For all of cPanel & WHM's features to function properly on IPv6, the <code>cpsrvd</code> daemon <strong>must</strong> listen on IPv6 addresses. To enable this functionality, select <em>On</em> for the <em>Listen on IPv6 Addresses</em> setting in the <a href="https://go.cpanel.net/whmdocsTweakSettings#system"><em>System</em></a> section of WHM's <a href="https://go.cpanel.net/whmdocsTweakSettings"><em>Tweak Settings</em></a> interface (<em>WHM >> Home >> Server Configuration >> Tweak Settings</em>).</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=TestRange</span></div><div><div html="<p>The IPv6 address range&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPv6 address range'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ipv6_range_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ipv6_range_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:R4kll8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kll8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kll8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kll8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kll8a:0" aria-labelledby="tab:R4kll8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
ipv6_range_usage <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'TestRange'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kll8a:1" aria-labelledby="tab:R4kll8a: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:R4sll8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sll8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sll8a:0" aria-labelledby="tab:R4sll8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"forbidden"</span>: <span class="token number">65536</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"free"</span>: <span class="token number">1000000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">20</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"ipv6_range_usage"</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/IPv6-Address-Settings/operation/ipv6_range_list" data-section-id="tag/IPv6-Address-Settings/operation/ipv6_range_list" class="sc-dntaoT ceciOs"><div data-section-id="operation/ipv6_range_list" id="operation/ipv6_range_list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/IPv6-Address-Settings/operation/ipv6_range_list" aria-label="tag/IPv6-Address-Settings/operation/ipv6_range_list"></a>Return available IPv6 address ranges<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists available IPv6 address ranges.</p>
<p><strong>Note:</strong></p>
<p>For all of cPanel &amp; WHM&#39;s features to function properly on IPv6, the <code>cpsrvd</code> daemon <strong>must</strong> listen on IPv6 addresses. To enable this functionality, select <em>On</em> for the <em>Listen on IPv6 Addresses</em> setting in the <a href="https://go.cpanel.net/whmdocsTweakSettings#system"><em>System</em></a> section of WHM&#39;s <a href="https://go.cpanel.net/whmdocsTweakSettings"><em>Tweak Settings</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>).</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 available IPv6 address ranges.</p>
<p><strong>Note:</strong></p>
<p>For all of cPanel & WHM's features to function properly on IPv6, the <code>cpsrvd</code> daemon <strong>must</strong> listen on IPv6 addresses. To enable this functionality, select <em>On</em> for the <em>Listen on IPv6 Addresses</em> setting in the <a href="https://go.cpanel.net/whmdocsTweakSettings#system"><em>System</em></a> section of WHM's <a href="https://go.cpanel.net/whmdocsTweakSettings"><em>Tweak Settings</em></a> interface (<em>WHM >> Home >> Server Configuration >> Tweak Settings</em>).</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ipv6_range_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ipv6_range_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:R4kml8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kml8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kml8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kml8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kml8a:0" aria-labelledby="tab:R4kml8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
ipv6_range_list
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kml8a:1" aria-labelledby="tab:R4kml8a: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:R4sml8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sml8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sml8a:0" aria-labelledby="tab:R4sml8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"range"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"CIDR"</span>: <span class="token string">"2001:db8:100:6::/64"</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">"first"</span>: <span class="token string">"2001:db8:0100:0006:0000:0000:0000:0000"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last"</span>: <span class="token string">"2001:db8:0100:0006:ffff:ffff:ffff:ffff"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mostrecent"</span>: <span class="token string">"2001:db8:0100:0006:0000:0000:0002:00ce"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"test_range"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"note"</span>: <span class="token string">"This is used for development."</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">"range_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">"user1"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reclaimed"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"2001:db8:0100:0006:0000:0000:0000:0002"</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">"metadata"</span>: <button class="collapser" aria-label="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">"ipv6_range_list"</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/IPv6-Address-Settings/operation/ipv6_range_remove" data-section-id="tag/IPv6-Address-Settings/operation/ipv6_range_remove" class="sc-dntaoT ceciOs"><div data-section-id="operation/ipv6_range_remove" id="operation/ipv6_range_remove" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/IPv6-Address-Settings/operation/ipv6_range_remove" aria-label="tag/IPv6-Address-Settings/operation/ipv6_range_remove"></a>Remove IPv6 address range<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes an IPv6 address range from the server.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function <strong>cannot</strong> modify the server&#39;s shared IPv6 address. To update that address, modify <a href="https://go.cpanel.net/advancedinstall">the <code>/etc/wwwacct.conf</code> file</a>, or use WHM&#39;s <a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup"><em>Basic WebHost Manager Setup</em></a> interface (<em>Home &gt;&gt; Server Configuration &gt;&gt; Basic WebHost Manager Setup</em>).</li>
<li>For all of cPanel &amp; WHM&#39;s features to function properly on IPv6, the <code>cpsrvd</code> daemon <strong>must</strong> listen on IPv6 addresses. To enable this functionality, select <em>On</em> for the <em>Listen on IPv6 Addresses</em> setting in the <em>System</em> section of WHM&#39;s <a href="https://go.cpanel.net/whmdocsTweakSettings"><em>Tweak Settings</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>).</li>
</ul>
<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 removes an IPv6 address range from the server.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function <strong>cannot</strong> modify the server's shared IPv6 address. To update that address, modify <a href="https://go.cpanel.net/advancedinstall">the <code>/etc/wwwacct.conf</code> file</a>, or use WHM's <a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup"><em>Basic WebHost Manager Setup</em></a> interface (<em>Home >> Server Configuration >> Basic WebHost Manager Setup</em>).</li>
<li>For all of cPanel & WHM's features to function properly on IPv6, the <code>cpsrvd</code> daemon <strong>must</strong> listen on IPv6 addresses. To enable this functionality, select <em>On</em> for the <em>Listen on IPv6 Addresses</em> setting in the <em>System</em> section of WHM's <a href="https://go.cpanel.net/whmdocsTweakSettings"><em>Tweak Settings</em></a> interface (<em>WHM >> Home >> Server Configuration >> Tweak Settings</em>).</li>
</ul>
<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=Range1</span></div><div><div html="<p>The IPv6 address range&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPv6 address range'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="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">/ipv6_range_remove</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ipv6_range_remove</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4knl8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4knl8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4knl8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knl8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4knl8a:0" aria-labelledby="tab:R4knl8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
ipv6_range_remove <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'Range1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knl8a:1" aria-labelledby="tab:R4knl8a: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:R4snl8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4snl8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4snl8a:0" aria-labelledby="tab:R4snl8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"ipv6_range_remove"</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/IPv6-Address-Settings/operation/listipv6s" data-section-id="tag/IPv6-Address-Settings/operation/listipv6s" class="sc-dntaoT ceciOs"><div data-section-id="operation/listipv6s" id="operation/listipv6s" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/IPv6-Address-Settings/operation/listipv6s" aria-label="tag/IPv6-Address-Settings/operation/listipv6s"></a>Return server's IPv6 addresses<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the IPv6 addresses bound to a server’s network interfaces.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the IPv6 addresses bound to a server’s network interfaces.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/listipv6s</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/listipv6s</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kol8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kol8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kol8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kol8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kol8a:0" aria-labelledby="tab:R4kol8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
listipv6s
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kol8a:1" aria-labelledby="tab:R4kol8a: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:R4sol8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sol8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sol8a:0" aria-labelledby="tab:R4sol8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ip"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"2001:0db8:0:0:1:0:0: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">"metadata"</span>: <button class="collapser" aria-label="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">"listipv6s"</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/Network-Address-Translation" data-section-id="tag/Network-Address-Translation" 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/Network-Address-Translation" aria-label="tag/Network-Address-Translation"></a>Network Address Translation</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>IP Address Management / Network Address Translation</p>
"><p>IP Address Management / Network Address Translation</p>
</div></div></div><div id="tag/Network-Address-Translation/operation/get_public_ip" data-section-id="tag/Network-Address-Translation/operation/get_public_ip" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_public_ip" id="operation/get_public_ip" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Network-Address-Translation/operation/get_public_ip" aria-label="tag/Network-Address-Translation/operation/get_public_ip"></a>Return public IP address of private IP address<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the public IP address for a specified public or private IP address. You can use this function to determine the system&#39;s main public IP address, especially for <a href="https://go.cpanel.net/11NAT">systems that use a 1:1 NAT configuration</a>.</p>
<ul>
<li>cPanel &amp; WHM uses the main public IP address to perform many different functions. For example, the system uses this IP address to verify the server&#39;s license status with WebPros International, LLC.</li>
<li>System administrators can configure the main public IP address in WHM&#39;s <a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup">Basic WebHost Manager Setup</a> interface (<em>Home &gt;&gt; Server Configuration &gt;&gt; Basic WebHost Manager Setup</em>).</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the public IP address for a specified public or private IP address. You can use this function to determine the system's main public IP address, especially for <a href="https://go.cpanel.net/11NAT">systems that use a 1:1 NAT configuration</a>.</p>
<ul>
<li>cPanel & WHM uses the main public IP address to perform many different functions. For example, the system uses this IP address to verify the server's license status with WebPros International, LLC.</li>
<li>System administrators can configure the main public IP address in WHM's <a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup">Basic WebHost Manager Setup</a> interface (<em>Home >> Server Configuration >> Basic WebHost Manager Setup</em>).</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="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><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">ip=192.0.2.0</span></div><div><div html="<p>A valid public or private IP address to query.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A valid public or private IP 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_public_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_public_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:R155n8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155n8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155n8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155n8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155n8a:0" aria-labelledby="tab:R155n8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_public_ip <span class="token punctuation">\</span>
<span class="token assign-left variable">ip</span><span class="token operator">=</span><span class="token string">'192.0.2.0'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155n8a:1" aria-labelledby="tab:R155n8a: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:R175n8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175n8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175n8a:0" aria-labelledby="tab:R175n8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"public_ip"</span>: <span class="token string">"192.0.2.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">"metadata"</span>: <button class="collapser" aria-label="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">"get_public_ip"</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/Network-Address-Translation/operation/nat_checkip" data-section-id="tag/Network-Address-Translation/operation/nat_checkip" class="sc-dntaoT ceciOs"><div data-section-id="operation/nat_checkip" id="operation/nat_checkip" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Network-Address-Translation/operation/nat_checkip" aria-label="tag/Network-Address-Translation/operation/nat_checkip"></a>Validate public IP address for NAT<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function validates a public IP address on a NAT-configured server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function validates a public IP address on a NAT-configured 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="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><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">ip=192.168.4.10</span></div><div><div html="<p>The local IPv4 address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The local IPv4 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/nat_checkip</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/nat_checkip</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R156n8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156n8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156n8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156n8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156n8a:0" aria-labelledby="tab:R156n8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
nat_checkip <span class="token punctuation">\</span>
<span class="token assign-left variable">ip</span><span class="token operator">=</span><span class="token string">'192.168.4.10'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156n8a:1" aria-labelledby="tab:R156n8a: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:R176n8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176n8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176n8a:0" aria-labelledby="tab:R176n8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"checked_ip"</span>: <span class="token string">"192.168.4.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">"metadata"</span>: <button class="collapser" aria-label="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">"nat_checkip"</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/Network-Address-Translation/operation/nat_set_public_ip" data-section-id="tag/Network-Address-Translation/operation/nat_set_public_ip" class="sc-dntaoT ceciOs"><div data-section-id="operation/nat_set_public_ip" id="operation/nat_set_public_ip" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Network-Address-Translation/operation/nat_set_public_ip" aria-label="tag/Network-Address-Translation/operation/nat_set_public_ip"></a>Register NAT IP address to public IP address<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function pairs a local IP address with a public IP address on NAT-configured servers.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function pairs a local IP address with a public IP address on NAT-configured servers.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="local_ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">local_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">local_ip=192.168.4.10</span></div><div><div html="<p>The local IPv4 address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The local IPv4 address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="public_ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">public_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">public_ip=10.5.3.33</span></div><div><div html="<p>The public IPv4 address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The public IPv4 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="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">/nat_set_public_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/nat_set_public_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:R157n8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R157n8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R157n8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R157n8a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R157n8a:0" aria-labelledby="tab:R157n8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
nat_set_public_ip <span class="token punctuation">\</span>
<span class="token assign-left variable">local_ip</span><span class="token operator">=</span><span class="token string">'192.168.4.10'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">public_ip</span><span class="token operator">=</span><span class="token string">'10.5.3.33'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R157n8a:1" aria-labelledby="tab:R157n8a: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:R177n8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R177n8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R177n8a:0" aria-labelledby="tab:R177n8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"nat_set_public_ip"</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/Management" data-section-id="tag/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/Management" aria-label="tag/Management"></a>Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Login Security (cPHulk) / Management</p>
"><p>Login Security (cPHulk) / Management</p>
</div></div></div><div id="tag/Management/operation/flush_cphulk_login_history" data-section-id="tag/Management/operation/flush_cphulk_login_history" class="sc-dntaoT ceciOs"><div data-section-id="operation/flush_cphulk_login_history" id="operation/flush_cphulk_login_history" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Management/operation/flush_cphulk_login_history" aria-label="tag/Management/operation/flush_cphulk_login_history"></a>Remove all login security records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes the login history entries from the cPHulk
database.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes the login history entries from the cPHulk
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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/flush_cphulk_login_history</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/flush_cphulk_login_history</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9j8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9j8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9j8q:0" aria-labelledby="tab:R2a9j8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
flush_cphulk_login_history
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j8q:1" aria-labelledby="tab:R2a9j8q: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:R2e9j8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9j8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9j8q:0" aria-labelledby="tab:R2e9j8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"records_removed"</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">"metadata"</span>: <button class="collapser" aria-label="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">"flush_cphulk_login_history"</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/Management/operation/flush_cphulk_login_history_for_ips" data-section-id="tag/Management/operation/flush_cphulk_login_history_for_ips" class="sc-dntaoT ceciOs"><div data-section-id="operation/flush_cphulk_login_history_for_ips" id="operation/flush_cphulk_login_history_for_ips" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Management/operation/flush_cphulk_login_history_for_ips" aria-label="tag/Management/operation/flush_cphulk_login_history_for_ips"></a>Remove login security IP address block<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes specific login history entries from the cPHulk database. Use this function to unblock one or more IP addresses.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes specific login history entries from the cPHulk database. Use this function to unblock one or more IP 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="last "><td kind="field" title="ip" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand ip"><span class="property-name">ip</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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 strings</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&ip=192.168.0.2&ip=192.168.0.3</span> -<!-- --> <!-- -->Multiple IPv4 addresses.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=2001:db8::1&ip=2002:db8::1&ip=2003:db8::1</span> -<!-- --> <!-- -->Multiple IPv6 addresses.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=192.168.0.1</span> -<!-- --> <!-- -->A single IPv4 address.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=2001:db8::1</span> -<!-- --> <!-- -->Single IPv6 Address</li></ul><div><div html="<p>The record&#39;s IP address.</p>
<p><strong>Note:</strong></p>
<p> To unblock multiple IP addresses, increment the parameter name (for example, to unblock three IP addresses, use the <code>ip-1</code>, <code>ip-2</code>, and <code>ip-3</code> parameters).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The record's IP address.</p>
<p><strong>Note:</strong></p>
<p> To unblock multiple IP addresses, increment the parameter name (for example, to unblock three IP addresses, use the <code>ip-1</code>, <code>ip-2</code>, and <code>ip-3</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/flush_cphulk_login_history_for_ips</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/flush_cphulk_login_history_for_ips</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aaj8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aaj8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aaj8q:0" aria-labelledby="tab:R2aaj8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
flush_cphulk_login_history_for_ips <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'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj8q:1" aria-labelledby="tab:R2aaj8q: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:R2eaj8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eaj8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eaj8q:0" aria-labelledby="tab:R2eaj8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"iptable_bans_removed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"records_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">"metadata"</span>: <button class="collapser" aria-label="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">"flush_cphulk_login_history_for_ips"</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/Management/operation/read_cphulk_records" data-section-id="tag/Management/operation/read_cphulk_records" class="sc-dntaoT ceciOs"><div data-section-id="operation/read_cphulk_records" id="operation/read_cphulk_records" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Management/operation/read_cphulk_records" aria-label="tag/Management/operation/read_cphulk_records"></a>Return login security list records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function displays a cPHulk list&#39;s records.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function displays a cPHulk list's 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=""><td kind="field" title="list_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">list_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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"black"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"white"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">list_name=white</span></div><div><div html="<p>The cPHulk list&#39;s name.</p>
<ul>
<li><code>black</code></li>
<li><code>white</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPHulk list's name.</p>
<ul>
<li><code>black</code></li>
<li><code>white</code></li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="skip_enabled_check" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skip_enabled_check</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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_enabled_check=1</span></div><div><div html="<p>Whether to skip checking if cPHulk runs on the server.</p>
<p><strong>Note:</strong></p>
<p> If cPHulk is disabled, the function returns the following message:
<code>cPHulk is disabled on the server.</code></p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip checking if cPHulk runs on the server.</p>
<p><strong>Note:</strong></p>
<p> If cPHulk is disabled, the function returns the following message:
<code>cPHulk is disabled on the server.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/read_cphulk_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/read_cphulk_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:R2abj8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abj8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abj8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abj8q:0" aria-labelledby="tab:R2abj8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
read_cphulk_records <span class="token punctuation">\</span>
<span class="token assign-left variable">list_name</span><span class="token operator">=</span><span class="token string">'white'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj8q:1" aria-labelledby="tab:R2abj8q: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:R2ebj8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebj8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebj8q:0" aria-labelledby="tab:R2ebj8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ips_in_list"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"10.1.4.44"</span>: <span class="token string">"A helpful comment about the IP address."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DEED::1"</span>: <span class="token string">"A helpful comment about the IP address."</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"list_name"</span>: <span class="token string">"white"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requester_ip"</span>: <span class="token string">"10.1.4.228"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requester_ip_is_whitelisted"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restart_ssh"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warning_ip"</span>: <span class="token string">"The IP address is not on the white list."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warning_ssh"</span>: <span class="token string">"The system disabled the UseDNS setting for sshd in order to add IP addresses to the whitelist. You must restart sshd to implement the change."</span></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">"command"</span>: <span class="token string">"read_cphulk_records"</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/Management/operation/create_cphulk_record" data-section-id="tag/Management/operation/create_cphulk_record" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_cphulk_record" id="operation/create_cphulk_record" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Management/operation/create_cphulk_record" aria-label="tag/Management/operation/create_cphulk_record"></a>Add login security record to list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds a new record or records to cPHulk&#39;s whitelist or blacklist.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds a new record or records to cPHulk's whitelist or blacklist.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> <!-- --><= 255<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">comment=George Wendt flying through the air.</span></div><div><div html="<p>A comment to include.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comment to include.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="ip" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand ip"><span class="property-name">ip</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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 strings or strings or strings or strings or strings</span><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->ip-address<!-- -->) </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&ip=192.168.0.2&ip=192.168.0.3</span> -<!-- --> <!-- -->Add multiple IP addresses.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=192.168.0.1</span> -<!-- --> <!-- -->Add a single IP address.</li></ul><div><div html="<p>The record&#39;s IP address, if there is only one IP address to add.</p>
<p><strong>Note:</strong></p>
<p>To add multiple IP addresses, increment the parameter name. For example, <code>ip-1</code>, <code>ip-2</code>, and <code>ip-3</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The record's IP address, if there is only one IP address to add.</p>
<p><strong>Note:</strong></p>
<p>To add multiple IP addresses, increment the parameter name. For example, <code>ip-1</code>, <code>ip-2</code>, and <code>ip-3</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="list_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">list_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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"black"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"white"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">list_name=white</span></div><div><div html="<p>The cPHulk list&#39;s name.</p>
<ul>
<li><code>black</code> - Add a new record or records to the blacklist.</li>
<li><code>white</code> - Add a new record or records to the whitelist.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPHulk list's name.</p>
<ul>
<li><code>black</code> - Add a new record or records to the blacklist.</li>
<li><code>white</code> - Add a new record or records to the whitelist.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="skip_enabled_check" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skip_enabled_check</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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_enabled_check=1</span></div><div><div html="<p>Whether to skip checking if cPHulk runs on the server.</p>
<ul>
<li><code>1</code> - Do <strong>not</strong> check if cPHulk is running.</li>
<li><code>0</code> - Check if cPHulk is running.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If cPHulk is disabled and you check its status, the function returns the following message: <code>cPHulk is disabled on the server.</code> </p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip checking if cPHulk runs on the server.</p>
<ul>
<li><code>1</code> - Do <strong>not</strong> check if cPHulk is running.</li>
<li><code>0</code> - Check if cPHulk is running.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If cPHulk is disabled and you check its status, the function returns the following message: <code>cPHulk is disabled on the server.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/create_cphulk_record</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/create_cphulk_record</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acj8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acj8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acj8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acj8q:0" aria-labelledby="tab:R2acj8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
create_cphulk_record <span class="token punctuation">\</span>
<span class="token assign-left variable">list_name</span><span class="token operator">=</span><span class="token string">'white'</span> <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'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj8q:1" aria-labelledby="tab:R2acj8q: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:R2ecj8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecj8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecj8q:0" aria-labelledby="tab:R2ecj8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"comment"</span>: <span class="token string">"George Wendt flying through the air."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_blocks_removed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ips_added"</span>: <button class="collapser" aria-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">"ips_failed"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"192.168.0.1"</span>: <span class="token string">"Invalid IP address or range: \"192.68.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">"iptable_bans_removed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"list_name"</span>: <span class="token string">"white"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requester_ip"</span>: <span class="token string">"10.1.4.228"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requester_ip_is_whitelisted"</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">"metadata"</span>: <button class="collapser" aria-label="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">"create_cphulk_record"</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/Management/operation/cphulk_status" data-section-id="tag/Management/operation/cphulk_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/cphulk_status" id="operation/cphulk_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Management/operation/cphulk_status" aria-label="tag/Management/operation/cphulk_status"></a>Return login security status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the status of the cPHulk service.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the status of the cPHulk 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/cphulk_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/cphulk_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:R2adj8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adj8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adj8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adj8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adj8q:0" aria-labelledby="tab:R2adj8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
cphulk_status
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adj8q:1" aria-labelledby="tab:R2adj8q: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:R2edj8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edj8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edj8q:0" aria-labelledby="tab:R2edj8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"service"</span>: <span class="token string">"cPHulk"</span></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">"command"</span>: <span class="token string">"cphulk_status"</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/Management/operation/delete_cphulk_record" data-section-id="tag/Management/operation/delete_cphulk_record" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_cphulk_record" id="operation/delete_cphulk_record" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Management/operation/delete_cphulk_record" aria-label="tag/Management/operation/delete_cphulk_record"></a>Remove login security record from list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deletes a record or records from cPHulk&#39;s whitelist or blacklist.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a record or records from cPHulk's whitelist or blacklist.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="ip" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand ip"><span class="property-name">ip</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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 strings or strings or strings or strings or strings</span><span class="sc-CNKsk sc-gcfzXs hPAOR kNKbJU"> (<!-- -->ip-address<!-- -->) </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&ip=192.168.0.2&ip=2001:db8::1&ip=2002:db8::1</span> -<!-- --> <!-- -->Multiple IP addresses.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=192.168.0.1</span> -<!-- --> <!-- -->Single IP address.</li></ul><div><div html="<p>The record&#39;s IP address.</p>
<p><strong>Note:</strong></p>
<p> To delete multiple IP addresses, increment the parameter name. For example, <code>ip-1</code>, <code>ip-2</code>, <code>ip-3</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The record's IP address.</p>
<p><strong>Note:</strong></p>
<p> To delete multiple IP addresses, increment the parameter name. For example, <code>ip-1</code>, <code>ip-2</code>, <code>ip-3</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="list_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">list_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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"white"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"black"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">list_name=white</span></div><div><div html="<p>The cPHulk list&#39;s name.</p>
<ul>
<li><code>white</code></li>
<li><code>black</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPHulk list's name.</p>
<ul>
<li><code>white</code></li>
<li><code>black</code></li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="skip_enabled_check" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skip_enabled_check</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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_enabled_check=1</span></div><div><div html="<p>Whether to skip checking if cPHulk runs on the server.</p>
<ul>
<li><code>1</code> - Don’t check cPHulk’s status.</li>
<li><code>0</code> - Check cPHulk’s status.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If cPHulk is disabled and you check its status, the function returns the following message:
<code>cPHulk is disabled on the server</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip checking if cPHulk runs on the server.</p>
<ul>
<li><code>1</code> - Don’t check cPHulk’s status.</li>
<li><code>0</code> - Check cPHulk’s status.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If cPHulk is disabled and you check its status, the function returns the following message:
<code>cPHulk is disabled on the server</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/delete_cphulk_record</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/delete_cphulk_record</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aej8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aej8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aej8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aej8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aej8q:0" aria-labelledby="tab:R2aej8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
delete_cphulk_record <span class="token punctuation">\</span>
<span class="token assign-left variable">list_name</span><span class="token operator">=</span><span class="token string">'white'</span> <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'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aej8q:1" aria-labelledby="tab:R2aej8q: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:R2eej8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eej8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eej8q:0" aria-labelledby="tab:R2eej8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ips_failed"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"192.168.0.1"</span>: <span class="token string">"This is why, alpha."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"192.168.9.1"</span>: <span class="token string">"This is why, beta."</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ips_removed"</span>: <button class="collapser" aria-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">"list_name"</span>: <span class="token string">"white"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requester_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">"requester_ip_is_whitelisted"</span>: <span class="token number">1</span></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">"command"</span>: <span class="token string">"delete_cphulk_record"</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/Management/operation/batch_create_cphulk_records" data-section-id="tag/Management/operation/batch_create_cphulk_records" class="sc-dntaoT ceciOs"><div data-section-id="operation/batch_create_cphulk_records" id="operation/batch_create_cphulk_records" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Management/operation/batch_create_cphulk_records" aria-label="tag/Management/operation/batch_create_cphulk_records"></a>Add login security record to list with comment<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds one or more records to cPHulk&#39;s whitelist or blacklist. The function includes the option to add unique comments for each IP address that you add.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds one or more records to cPHulk's whitelist or blacklist. The function includes the option to add unique comments for each IP address that you add.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></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=""><td kind="field" title="api.version" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">api.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">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><div html="<p>The WHM API version number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WHM API version number.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="list_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">list_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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"black"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"white"</span> </div> <div><div html="<p>The cPHulk list&#39;s name.</p>
<ul>
<li><code>black</code> - Add a new record or records to the blacklist.</li>
<li><code>white</code> - Add a new record or records to the whitelist.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPHulk list's name.</p>
<ul>
<li><code>black</code> - Add a new record or records to the blacklist.</li>
<li><code>white</code> - Add a new record or records to the whitelist.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="records" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand records"><span class="property-name">records</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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">objects</span></div> <div><div html="<p>The list of records to add to the whitelist or blacklist.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The list of records to add to the whitelist or blacklist.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="skip_enabled_check" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skip_enabled_check</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether to skip checking if cPHulk runs on the server.</p>
<ul>
<li><code>1</code> - Do <strong>not</strong> check if cPHulk is running.</li>
<li><code>0</code> - Check if cPHulk is running.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If cPHulk is disabled and you check its status, the function returns the following message: <code>cPHulk is disabled on the server.</code> </p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip checking if cPHulk runs on the server.</p>
<ul>
<li><code>1</code> - Do <strong>not</strong> check if cPHulk is running.</li>
<li><code>0</code> - Check if cPHulk is running.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If cPHulk is disabled and you check its status, the function returns the following message: <code>cPHulk is disabled on the server.</code> </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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/batch_create_cphulk_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/batch_create_cphulk_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:R2afj8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2afj8q:0" tabindex="0" data-rttab="true">Payload</li><li class="react-tabs__tab" role="tab" id="tab:R2afj8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afj8q:1" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2afj8q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afj8q: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:R2afj8q:0" aria-labelledby="tab:R2afj8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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.version"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"list_name"</span>: <span class="token string">"white"</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">"comment"</span>: <span class="token string">"Automated update tools."</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></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"comment"</span>: <span class="token string">"System administrators and support systems."</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.1.0/30"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"comment"</span>: <span class="token string">"Owner of 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">"122.1.56.7-122.1.56.8"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"comment"</span>: <span class="token string">"Special access group 1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"2001:db9::"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"comment"</span>: <span class="token string">"Special access group 1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"2001:db9::1-2001:db9::5"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"comment"</span>: <span class="token string">"Special access group 2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"2001:db8::/32"</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:R2afj8q:1" aria-labelledby="tab:R2afj8q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afj8q:2" aria-labelledby="tab:R2afj8q: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:R2efj8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2efj8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2efj8q:0" aria-labelledby="tab:R2efj8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"comment"</span>: <span class="token string">"George Wendt flying through the air."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_blocks_removed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ips_added"</span>: <button class="collapser" aria-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><li><div class="hoverable "><span class="token string">"192.168.1.0-192.168.1.3"</span>,</div></li><li><div class="hoverable "><span class="token string">"122.1.56.7-122.1.56.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">"ips_failed"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"192.168.0.1"</span>: <span class="token string">"Invalid IP address or range: \"192.68.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">"iptable_bans_removed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"list_name"</span>: <span class="token string">"white"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"original_ips_added"</span>: <button class="collapser" aria-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><li><div class="hoverable "><span class="token string">"192.168.1.0/30"</span>,</div></li><li><div class="hoverable "><span class="token string">"122.1.56.7-122.1.56.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">"requester_ip"</span>: <span class="token string">"10.1.4.228"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requester_ip_is_whitelisted"</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">"metadata"</span>: <button class="collapser" aria-label="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">"batch_create_cphulk_records"</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/Reporting" data-section-id="tag/Reporting" 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/Reporting" aria-label="tag/Reporting"></a>Reporting</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Login Security (cPHulk) / Reporting</p>
"><p>Login Security (cPHulk) / Reporting</p>
</div></div></div><div id="tag/Reporting/operation/get_countries_with_known_ip_ranges" data-section-id="tag/Reporting/operation/get_countries_with_known_ip_ranges" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_countries_with_known_ip_ranges" id="operation/get_countries_with_known_ip_ranges" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Reporting/operation/get_countries_with_known_ip_ranges" aria-label="tag/Reporting/operation/get_countries_with_known_ip_ranges"></a>Return login security country codes<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the country codes available for whitelist and blacklist functions.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the country codes available for whitelist and blacklist 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_countries_with_known_ip_ranges</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_countries_with_known_ip_ranges</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9l8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9l8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9l8q:0" aria-labelledby="tab:R2a9l8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_countries_with_known_ip_ranges
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9l8q:1" aria-labelledby="tab:R2a9l8q: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:R2e9l8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9l8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9l8q:0" aria-labelledby="tab:R2e9l8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"countries"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</span>: <span class="token string">"US"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"United States"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_countries_with_known_ip_ranges"</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/Reporting/operation/get_cphulk_brutes" data-section-id="tag/Reporting/operation/get_cphulk_brutes" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_cphulk_brutes" id="operation/get_cphulk_brutes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Reporting/operation/get_cphulk_brutes" aria-label="tag/Reporting/operation/get_cphulk_brutes"></a>Return login security brute force attacks<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists brute force attack entries from the cPHulk database.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists brute force attack entries from the cPHulk 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_cphulk_brutes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_cphulk_brutes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aal8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aal8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aal8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aal8q:0" aria-labelledby="tab:R2aal8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_cphulk_brutes
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aal8q:1" aria-labelledby="tab:R2aal8q: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:R2eal8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eal8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eal8q:0" aria-labelledby="tab:R2eal8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"brutes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exptime"</span>: <span class="token string">"2014-12-07T00:00:00.000Z"</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">"logintime"</span>: <span class="token string">"2014-11-20T00:00:00.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notes"</span>: <span class="token string">"this was a triumph"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timeleft"</span>: <span class="token number">14</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_cphulk_brutes"</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/Reporting/operation/get_cphulk_excessive_brutes" data-section-id="tag/Reporting/operation/get_cphulk_excessive_brutes" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_cphulk_excessive_brutes" id="operation/get_cphulk_excessive_brutes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Reporting/operation/get_cphulk_excessive_brutes" aria-label="tag/Reporting/operation/get_cphulk_excessive_brutes"></a>Return login security excessive brute force attacks<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves excessive brute force attack entries from the cPHulk database.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves excessive brute force attack entries from the cPHulk 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_cphulk_excessive_brutes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_cphulk_excessive_brutes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abl8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abl8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abl8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abl8q:0" aria-labelledby="tab:R2abl8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_cphulk_excessive_brutes
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl8q:1" aria-labelledby="tab:R2abl8q: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:R2ebl8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebl8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebl8q:0" aria-labelledby="tab:R2ebl8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"excessive_brutes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exptime"</span>: <span class="token string">"2014-12-07T00:00:00.000Z"</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">"logintime"</span>: <span class="token string">"2014-11-20T00:00:00.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notes"</span>: <span class="token string">"this was a triumph"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timeleft"</span>: <span class="token number">14</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_cphulk_excessive_brutes"</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/Reporting/operation/get_cphulk_user_brutes" data-section-id="tag/Reporting/operation/get_cphulk_user_brutes" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_cphulk_user_brutes" id="operation/get_cphulk_user_brutes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Reporting/operation/get_cphulk_user_brutes" aria-label="tag/Reporting/operation/get_cphulk_user_brutes"></a>Return login security brute force attacks by user<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists brute force attack entries from the cPHulk database, ordered by user accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists brute force attack entries from the cPHulk database, ordered by user 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_cphulk_user_brutes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_cphulk_user_brutes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acl8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acl8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acl8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acl8q:0" aria-labelledby="tab:R2acl8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_cphulk_user_brutes
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl8q:1" aria-labelledby="tab:R2acl8q: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:R2ecl8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecl8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecl8q:0" aria-labelledby="tab:R2ecl8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_brutes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"authservice"</span>: <span class="token string">"dovecot"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exptime"</span>: <span class="token string">"2014-12-07T00:00:00.000Z"</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">"logintime"</span>: <span class="token string">"2014-11-20T00:00:00.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timeleft"</span>: <span class="token number">14</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></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">"metadata"</span>: <button class="collapser" aria-label="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">"get_cphulk_user_brutes"</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/Reporting/operation/get_cphulk_failed_logins" data-section-id="tag/Reporting/operation/get_cphulk_failed_logins" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_cphulk_failed_logins" id="operation/get_cphulk_failed_logins" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Reporting/operation/get_cphulk_failed_logins" aria-label="tag/Reporting/operation/get_cphulk_failed_logins"></a>Return login security failed logins<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists failed login attempt entries from the cPHulk database.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists failed login attempt entries from the cPHulk 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_cphulk_failed_logins</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_cphulk_failed_logins</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adl8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adl8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adl8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adl8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adl8q:0" aria-labelledby="tab:R2adl8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_cphulk_failed_logins
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adl8q:1" aria-labelledby="tab:R2adl8q: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:R2edl8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edl8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edl8q:0" aria-labelledby="tab:R2edl8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_logins"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"authservice"</span>: <span class="token string">"dovecot"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exptime"</span>: <span class="token string">"2014-12-07T00:00:00.000Z"</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">"logintime"</span>: <span class="token string">"2014-11-20T00:00:00.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"ftp"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timeleft"</span>: <span class="token number">14</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></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">"metadata"</span>: <button class="collapser" aria-label="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">"get_cphulk_failed_logins"</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/Settings" data-section-id="tag/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/Settings" aria-label="tag/Settings"></a>Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Login Security (cPHulk) / Settings</p>
"><p>Login Security (cPHulk) / Settings</p>
</div></div></div><div id="tag/Settings/operation/enable_cphulk" data-section-id="tag/Settings/operation/enable_cphulk" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_cphulk" id="operation/enable_cphulk" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Settings/operation/enable_cphulk" aria-label="tag/Settings/operation/enable_cphulk"></a>Enable login security<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables the cPHulk service.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables the cPHulk 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/enable_cphulk</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/enable_cphulk</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9n8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9n8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9n8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9n8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9n8q:0" aria-labelledby="tab:R2a9n8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
enable_cphulk
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9n8q:1" aria-labelledby="tab:R2a9n8q: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:R2e9n8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9n8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9n8q:0" aria-labelledby="tab:R2e9n8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"enable_cphulk"</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/Settings/operation/disable_cphulk" data-section-id="tag/Settings/operation/disable_cphulk" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_cphulk" id="operation/disable_cphulk" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Settings/operation/disable_cphulk" aria-label="tag/Settings/operation/disable_cphulk"></a>Disable login security<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function disables the cPHulk service.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables the cPHulk 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/disable_cphulk</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/disable_cphulk</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aan8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aan8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aan8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aan8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aan8q:0" aria-labelledby="tab:R2aan8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
disable_cphulk
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aan8q:1" aria-labelledby="tab:R2aan8q: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:R2ean8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ean8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ean8q:0" aria-labelledby="tab:R2ean8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"disable_cphulk"</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/Settings/operation/load_cphulk_config" data-section-id="tag/Settings/operation/load_cphulk_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/load_cphulk_config" id="operation/load_cphulk_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Settings/operation/load_cphulk_config" aria-label="tag/Settings/operation/load_cphulk_config"></a>Return login security configuration settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns cPHulk&#39;s current settings.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns cPHulk's current 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/load_cphulk_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/load_cphulk_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:R2abn8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abn8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abn8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abn8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abn8q:0" aria-labelledby="tab:R2abn8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
load_cphulk_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abn8q:1" aria-labelledby="tab:R2abn8q: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:R2ebn8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebn8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebn8q:0" aria-labelledby="tab:R2ebn8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cphulk_config"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"block_brute_force_with_firewall"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"block_excessive_brute_force_with_firewall"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"brute_force_period_mins"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"brute_force_period_sec"</span>: <span class="token number">360</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_temp_ban_firewall"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"command_to_run_on_brute_force"</span>: <span class="token string">"echo \"BRUTE\""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"command_to_run_on_excessive_brute_force"</span>: <span class="token string">"echo \"TOO MUCH BRUTE\""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_based_protection"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_brute_force_period_mins"</span>: <span class="token number">15</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_brute_force_period_sec"</span>: <span class="token number">300</span><span class="token punctuation">,</span></div></li><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">"lookback_period_min"</span>: <span class="token number">360</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lookback_time"</span>: <span class="token number">21600</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mark_as_brute"</span>: <span class="token number">30</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_failures"</span>: <span class="token number">30</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_failures_byip"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_on_brute"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_on_root_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_on_root_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">"username_based_protection"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username_based_protection_for_root"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username_based_protection_local_origin"</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">"metadata"</span>: <button class="collapser" aria-label="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">"load_cphulk_config"</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/Settings/operation/save_cphulk_config" data-section-id="tag/Settings/operation/save_cphulk_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/save_cphulk_config" id="operation/save_cphulk_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Settings/operation/save_cphulk_config" aria-label="tag/Settings/operation/save_cphulk_config"></a>Save login security configuration settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function modifies cPHulk&#39;s configuration settings.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies cPHulk's 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=""><td kind="field" title="block_brute_force_with_firewall" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">block_brute_force_with_firewall</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">block_brute_force_with_firewall=0</span></div><div><div html="<p>Whether to use the server firewall to block brute force attacks.</p>
<ul>
<li><code>1</code> — Use the firewall.</li>
<li><code>0</code> — Do <strong>not</strong> use the firewall.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use the server firewall to block brute force attacks.</p>
<ul>
<li><code>1</code> — Use the firewall.</li>
<li><code>0</code> — Do <strong>not</strong> use the firewall.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="block_excessive_brute_force_with_firewall" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">block_excessive_brute_force_with_firewall</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">block_excessive_brute_force_with_firewall=0</span></div><div><div html="<p>Whether to use the server firewall to block excessive brute force attacks.</p>
<ul>
<li><code>1</code> — Use the firewall.</li>
<li><code>0</code> — Do <strong>not</strong> use the firewall.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use the server firewall to block excessive brute force attacks.</p>
<ul>
<li><code>1</code> — Use the firewall.</li>
<li><code>0</code> — Do <strong>not</strong> use the firewall.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="brute_force_period_mins" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">brute_force_period_mins</span></td><td class="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">5</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">brute_force_period_mins=5</span></div><div><div html="<p>The number of minutes over which cPHulk measures all login attempts to a specific user&#39;s account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of minutes over which cPHulk measures all login attempts to a specific user's account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="command_to_run_on_brute_force" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">command_to_run_on_brute_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">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">command_to_run_on_brute_force=</span></div><div><div html="<p>The command to run when an IP address triggers brute force protection.</p>
<p><strong>Note:</strong></p>
<p> For a list of commands, read the <em>Command variables</em> section of our <a href="https://go.cpanel.net/whmdocscPHulkBruteForceProtection">cPHulk Brute Force Protection</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The command to run when an IP address triggers brute force protection.</p>
<p><strong>Note:</strong></p>
<p> For a list of commands, read the <em>Command variables</em> section of our <a href="https://go.cpanel.net/whmdocscPHulkBruteForceProtection">cPHulk Brute Force Protection</a> documentation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="command_to_run_on_excessive_brute_force" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">command_to_run_on_excessive_brute_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">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">command_to_run_on_excessive_brute_force=</span></div><div><div html="<p>The command to run when the system blocks an IP address for a one day period.</p>
<p><strong>Note:</strong></p>
<p> For a list of commands, read the <em>Command variables</em> section of our <a href="https://go.cpanel.net/whmdocscPHulkBruteForceProtection">cPHulk Brute Force Protection</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The command to run when the system blocks an IP address for a one day period.</p>
<p><strong>Note:</strong></p>
<p> For a list of commands, read the <em>Command variables</em> section of our <a href="https://go.cpanel.net/whmdocscPHulkBruteForceProtection">cPHulk Brute Force Protection</a> documentation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="ip_based_protection" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ip_based_protection</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">ip_based_protection=1</span></div><div><div html="<p>Whether to enable IP address-based protection on all requests.</p>
<ul>
<li><code>1</code> — Enable IP-based protection.</li>
<li><code>0</code> — Disable IP-based protection.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If you set this parameter to <code>0</code>, you <strong>cannot</strong> use the following parameters:</p>
<ul>
<li><code>block_brute_force_with_firewall</code></li>
<li><code>block_excessive_brute_force_with_firewall</code></li>
<li><code>ip_brute_force_period_mins</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable IP address-based protection on all requests.</p>
<ul>
<li><code>1</code> — Enable IP-based protection.</li>
<li><code>0</code> — Disable IP-based protection.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If you set this parameter to <code>0</code>, you <strong>cannot</strong> use the following parameters:</p>
<ul>
<li><code>block_brute_force_with_firewall</code></li>
<li><code>block_excessive_brute_force_with_firewall</code></li>
<li><code>ip_brute_force_period_mins</code></li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="ip_brute_force_period_mins" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ip_brute_force_period_mins</span></td><td class="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">15</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip_brute_force_period_mins=15</span></div><div><div html="<p>The number of minutes in which cPHulk measures an attacker&#39;s login attempts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of minutes in which cPHulk measures an attacker's login attempts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="lookback_period_min" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">lookback_period_min</span></td><td class="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">360</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">lookback_period_min=360</span></div><div><div html="<p>The number of minutes over which cPHulk counts failed logins against a user.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of minutes over which cPHulk counts failed logins against a user.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="mark_as_brute" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mark_as_brute</span></td><td class="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">30</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mark_as_brute=30</span></div><div><div html="<p>The maximum number of failures from a specific IP address before cPHulk blocks that address for a two-week period.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of failures from a specific IP address before cPHulk blocks that address for a two-week period.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_failures" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">max_failures</span></td><td class="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">30</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">max_failures=30</span></div><div><div html="<p>The maximum number of failures that cPHulk allows per account within the defined time range.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of failures that cPHulk allows per account within the defined time range.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_failures_byip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">max_failures_byip</span></td><td class="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">5</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">max_failures_byip=5</span></div><div><div html="<p>The maximum number of failures from a specific IP address before cPHulk locks out that address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of failures from a specific IP address before cPHulk locks out that address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_on_brute" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_on_brute</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_on_brute=0</span></div><div><div html="<p>Whether cPHulk will send a notification when it detects a brute force attack.</p>
<ul>
<li><code>1</code> — Send the notification.</li>
<li><code>0</code> — Do <strong>not</strong> send the notification.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether cPHulk will send a notification when it detects a brute force attack.</p>
<ul>
<li><code>1</code> — Send the notification.</li>
<li><code>0</code> — Do <strong>not</strong> send the notification.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_on_root_login" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_on_root_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">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">notify_on_root_login=0</span></div><div><div html="<p>Whether cPHulk will send a notification when the <code>root</code> user successfully logs in from an IP address that is not on the whitelist.</p>
<ul>
<li><code>1</code> — Send the notification.</li>
<li><code>0</code> — Do <strong>not</strong> send the notification.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether cPHulk will send a notification when the <code>root</code> user successfully logs in from an IP address that is not on the whitelist.</p>
<ul>
<li><code>1</code> — Send the notification.</li>
<li><code>0</code> — Do <strong>not</strong> send the notification.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="notify_on_root_login_for_known_netblock" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notify_on_root_login_for_known_netblock</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">notify_on_root_login_for_known_netblock=0</span></div><div><div html="<p>Whether cPHulk sends a notification upon successful <code>root</code> login when the IP address is not on the whitelist, but from a known netblock.</p>
<ul>
<li><code>1</code> — Send the notification.</li>
<li><code>0</code> — Do <strong>not</strong> send the notification.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether cPHulk sends a notification upon successful <code>root</code> login when the IP address is not on the whitelist, but from a known netblock.</p>
<ul>
<li><code>1</code> — Send the notification.</li>
<li><code>0</code> — Do <strong>not</strong> send the notification.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skip_enabled_check" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skip_enabled_check</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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_enabled_check=0</span></div><div><div html="<p>Whether to skip checking if cPHulk runs on the server.</p>
<ul>
<li><code>1</code> — Don&#39;t check cPHulk&#39;s status.</li>
<li><code>0</code> — Check cPHulk&#39;s status.</li>
</ul>
<p><strong>Note:</strong></p>
<p>If cPHulk is disabled, the function returns the following message:
<code>cPHulk is disabled on the server.</code></p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip checking if cPHulk runs on the server.</p>
<ul>
<li><code>1</code> — Don't check cPHulk's status.</li>
<li><code>0</code> — Check cPHulk's status.</li>
</ul>
<p><strong>Note:</strong></p>
<p>If cPHulk is disabled, the function returns the following message:
<code>cPHulk is disabled on the server.</code></p>
</div></div></div></td></tr><tr class=""><td kind="field" title="username_based_protection" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">username_based_protection</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">username_based_protection=0</span></div><div><div html="<p>Whether to enable username-based protection on all requests.</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 username-based protection on all requests.</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="username_based_protection_for_root" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">username_based_protection_for_root</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">username_based_protection_for_root=0</span></div><div><div html="<p>Whether to allow username-based protection to lock out the <code>root</code> user.</p>
<ul>
<li><code>1</code> — Allow.</li>
<li><code>0</code> — Do <strong>not</strong> allow.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow username-based protection to lock out the <code>root</code> user.</p>
<ul>
<li><code>1</code> — Allow.</li>
<li><code>0</code> — Do <strong>not</strong> allow.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="username_based_protection_local_origin" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">username_based_protection_local_origin</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">username_based_protection_local_origin=1</span></div><div><div html="<p>Whether to enable username-based protection <strong>only</strong> on requests that originate from a local IP address.</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 username-based protection <strong>only</strong> on requests that originate from a local IP address.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/save_cphulk_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/save_cphulk_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:R2acn8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acn8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acn8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acn8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acn8q:0" aria-labelledby="tab:R2acn8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
save_cphulk_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acn8q:1" aria-labelledby="tab:R2acn8q: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:R2ecn8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecn8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecn8q:0" aria-labelledby="tab:R2ecn8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cphulk_config"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"block_brute_force_with_firewall"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"block_excessive_brute_force_with_firewall"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"brute_force_period_mins"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"brute_force_period_sec"</span>: <span class="token number">300</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_temp_ban_firewall"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"command_to_run_on_brute_force"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"command_to_run_on_excessive_brute_force"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_based_protection"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_brute_force_period_mins"</span>: <span class="token number">15</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_brute_force_period_sec"</span>: <span class="token number">900</span><span class="token punctuation">,</span></div></li><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">"lookback_period_min"</span>: <span class="token number">360</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lookback_time"</span>: <span class="token number">21600</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mark_as_brute"</span>: <span class="token number">30</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_failures"</span>: <span class="token number">30</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_failures_byip"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_on_brute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_on_root_login"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_on_root_login_for_known_netblock"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username_based_protection"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username_based_protection_for_root"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username_based_protection_local_origin"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restart_ssh"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warning"</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">"metadata"</span>: <button class="collapser" aria-label="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">"save_cphulk_config"</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/Settings/operation/set_cphulk_config_key" data-section-id="tag/Settings/operation/set_cphulk_config_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_cphulk_config_key" id="operation/set_cphulk_config_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Settings/operation/set_cphulk_config_key" aria-label="tag/Settings/operation/set_cphulk_config_key"></a>Update login security configuration settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function modifies a single cPHulk configuration settings as specified.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies a single cPHulk configuration settings as specified.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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" 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></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"block_brute_force_with_firewall"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"block_excessive_brute_force_with_firewall"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"brute_force_period_mins"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"brute_force_period_sec"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"command_to_run_on_brute_force"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"command_to_run_on_excessive_brute_force"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"country_blacklist"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"country_whitelist"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ip_based_protection"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ip_brute_force_period_mins"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ip_brute_force_period_sec"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"is_enabled"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"lookback_period_min"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"lookback_time"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mark_as_brute"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"max_failures"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"max_failures_byip"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"notify_on_brute"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"notify_on_root_login"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"notify_on_root_login_for_known_netblock"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"username_based_protection"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"username_based_protection_for_root"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"username_based_protection_local_origin"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=is_enabled</span></div><div><div html="<p>The configuration key for the setting to set/modify.</p>
<p>It should be one of the following:</p>
<ul>
<li><code>block_brute_force_with_firewall</code> - Whether to use cPanel &amp; WHM&#39;s firewall to block brute force attacks.</li>
<li><code>block_excessive_brute_force_with_firewall</code> - Whether to use cPanel &amp; WHM&#39;s firewall to block excessive brute force attacks.</li>
<li><code>brute_force_period_mins</code> - The number of minutes over which cPHulk measures all login attempts to a specific user&#39;s account.</li>
<li><code>brute_force_period_sec</code> - The number of seconds over which cPHulk measures all login attempts to a specific user&#39;s account.</li>
<li><code>command_to_run_on_brute_force</code> - The command to run when an IP address triggers brute force protection.</li>
<li><code>command_to_run_on_excessive_brute_force</code> - The command to run when the system blocks an IP address blocked for a one day period.</li>
<li><code>country_blacklist</code> - The countries to blacklist.</li>
<li><code>country_whitelist</code> - The countries to whitelist.</li>
<li><code>ip_based_protection</code> - Whether to enable IP address-based protection on all requests.</li>
<li><code>ip_brute_force_period_mins</code> - The number of minutes in which cPHulk measures an attacker&#39;s login attempts.</li>
<li><code>ip_brute_force_period_sec</code> - The number of seconds in which cPHulk measures an attacker&#39;s login attempts.</li>
<li><code>is_enabled</code> - Whether to enable the cPHulk service.</li>
<li><code>lookback_period_min</code> - The number of minutes over which cPHulk counts failed logins against a user.</li>
<li><code>lookback_time</code> - The number of seconds over which cPHulk counts failed logins against a user.</li>
<li><code>mark_as_brute</code> - The maximum number of failures from a specific IP address before cPHulk blocks that address for a two-week period.</li>
<li><code>max_failures</code> - The maximum number of failures that cPHulk allows per account within the defined time range.</li>
<li><code>max_failures_byip</code> - The maximum number of failures from a specific IP address before cPHulk locks out that address.</li>
<li><code>notify_on_brute</code> - Whether cPHulk will send a notification when it detects a brute force attack.</li>
<li><code>notify_on_root_login</code> - Whether cPHulk will send a notification when the root user successfully logs in from an IP address that is <strong>not</strong> on the whitelist.</li>
<li><code>notify_on_root_login_for_known_netblock</code> - Whether cPHulk sends a notification upon successful root login when the IP address is <strong>not</strong> on the whitelist, but from a known netblock.</li>
<li><code>username_based_protection</code> - Whether to enable username-based protection on all requests.</li>
<li><code>username_based_protection_for_root</code> - Whether to allow username-based protection to lock out the root user.</li>
<li><code>username_based_protection_local_origin</code> - Whether to enable username-based protection only on requests that originate from a local IP address.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The configuration key for the setting to set/modify.</p>
<p>It should be one of the following:</p>
<ul>
<li><code>block_brute_force_with_firewall</code> - Whether to use cPanel & WHM's firewall to block brute force attacks.</li>
<li><code>block_excessive_brute_force_with_firewall</code> - Whether to use cPanel & WHM's firewall to block excessive brute force attacks.</li>
<li><code>brute_force_period_mins</code> - The number of minutes over which cPHulk measures all login attempts to a specific user's account.</li>
<li><code>brute_force_period_sec</code> - The number of seconds over which cPHulk measures all login attempts to a specific user's account.</li>
<li><code>command_to_run_on_brute_force</code> - The command to run when an IP address triggers brute force protection.</li>
<li><code>command_to_run_on_excessive_brute_force</code> - The command to run when the system blocks an IP address blocked for a one day period.</li>
<li><code>country_blacklist</code> - The countries to blacklist.</li>
<li><code>country_whitelist</code> - The countries to whitelist.</li>
<li><code>ip_based_protection</code> - Whether to enable IP address-based protection on all requests.</li>
<li><code>ip_brute_force_period_mins</code> - The number of minutes in which cPHulk measures an attacker's login attempts.</li>
<li><code>ip_brute_force_period_sec</code> - The number of seconds in which cPHulk measures an attacker's login attempts.</li>
<li><code>is_enabled</code> - Whether to enable the cPHulk service.</li>
<li><code>lookback_period_min</code> - The number of minutes over which cPHulk counts failed logins against a user.</li>
<li><code>lookback_time</code> - The number of seconds over which cPHulk counts failed logins against a user.</li>
<li><code>mark_as_brute</code> - The maximum number of failures from a specific IP address before cPHulk blocks that address for a two-week period.</li>
<li><code>max_failures</code> - The maximum number of failures that cPHulk allows per account within the defined time range.</li>
<li><code>max_failures_byip</code> - The maximum number of failures from a specific IP address before cPHulk locks out that address.</li>
<li><code>notify_on_brute</code> - Whether cPHulk will send a notification when it detects a brute force attack.</li>
<li><code>notify_on_root_login</code> - Whether cPHulk will send a notification when the root user successfully logs in from an IP address that is <strong>not</strong> on the whitelist.</li>
<li><code>notify_on_root_login_for_known_netblock</code> - Whether cPHulk sends a notification upon successful root login when the IP address is <strong>not</strong> on the whitelist, but from a known netblock.</li>
<li><code>username_based_protection</code> - Whether to enable username-based protection on all requests.</li>
<li><code>username_based_protection_for_root</code> - Whether to allow username-based protection to lock out the root user.</li>
<li><code>username_based_protection_local_origin</code> - Whether to enable username-based protection only on requests that originate from a local IP address.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="value" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand value"><span class="property-name">value</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">value=1</span></div><div><div html="<p>The new value for the specified key. The allowable value depends on which key is being set.</p>
<p>For the following keys, the value must be 0 or 1:</p>
<ul>
<li><code>block_brute_force_with_firewall</code></li>
<li><code>block_excessive_brute_force_with_firewall</code></li>
<li><code>ip_based_protection</code></li>
<li><code>is_enabled</code></li>
<li><code>notify_on_brute</code></li>
<li><code>notify_on_root_login</code></li>
<li><code>notify_on_root_login_for_known_netblock</code></li>
<li><code>username_based_protection</code></li>
<li><code>username_based_protection_for_root</code></li>
<li><code>username_based_protection_local_origin</code></li>
</ul>
<p>For the following keys, the value must be an integer which specifies a number of minutes or seconds:</p>
<ul>
<li><code>brute_force_period_mins</code></li>
<li><code>brute_force_period_sec</code></li>
<li><code>ip_brute_force_period_mins</code></li>
<li><code>ip_brute_force_period_sec</code></li>
<li><code>lookback_period_min</code></li>
<li><code>lookback_time</code> - This one is in seconds despite not having <code>sec</code> in the name</li>
</ul>
<p>These keys require the value to be a string containing a command to be run:
(For a list of commands, read the <em>Command Variables</em> section of our <a href="https://go.cpanel.net/whmdocscPHulkBruteForceProtection">cPHulk Brute Force Protection</a> documentation.)</p>
<ul>
<li><code>command_to_run_on_brute_force</code></li>
<li><code>command_to_run_on_excessive_brute_force</code></li>
</ul>
<p>These keys require the value to be a string containing a comma-separated list of country codes:
(For a list of countries, run the WHM API 1 <code>get_countries_with_known_ip_ranges</code> function.)</p>
<ul>
<li><code>country_blacklist</code></li>
<li><code>country_whitelist</code></li>
</ul>
<p>The following keys require an integer representing a maximum number of failures</p>
<ul>
<li><code>mark_as_brute</code></li>
<li><code>max_failures</code></li>
<li><code>max_failures_byip</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new value for the specified key. The allowable value depends on which key is being set.</p>
<p>For the following keys, the value must be 0 or 1:</p>
<ul>
<li><code>block_brute_force_with_firewall</code></li>
<li><code>block_excessive_brute_force_with_firewall</code></li>
<li><code>ip_based_protection</code></li>
<li><code>is_enabled</code></li>
<li><code>notify_on_brute</code></li>
<li><code>notify_on_root_login</code></li>
<li><code>notify_on_root_login_for_known_netblock</code></li>
<li><code>username_based_protection</code></li>
<li><code>username_based_protection_for_root</code></li>
<li><code>username_based_protection_local_origin</code></li>
</ul>
<p>For the following keys, the value must be an integer which specifies a number of minutes or seconds:</p>
<ul>
<li><code>brute_force_period_mins</code></li>
<li><code>brute_force_period_sec</code></li>
<li><code>ip_brute_force_period_mins</code></li>
<li><code>ip_brute_force_period_sec</code></li>
<li><code>lookback_period_min</code></li>
<li><code>lookback_time</code> - This one is in seconds despite not having <code>sec</code> in the name</li>
</ul>
<p>These keys require the value to be a string containing a command to be run:
(For a list of commands, read the <em>Command Variables</em> section of our <a href="https://go.cpanel.net/whmdocscPHulkBruteForceProtection">cPHulk Brute Force Protection</a> documentation.)</p>
<ul>
<li><code>command_to_run_on_brute_force</code></li>
<li><code>command_to_run_on_excessive_brute_force</code></li>
</ul>
<p>These keys require the value to be a string containing a comma-separated list of country codes:
(For a list of countries, run the WHM API 1 <code>get_countries_with_known_ip_ranges</code> function.)</p>
<ul>
<li><code>country_blacklist</code></li>
<li><code>country_whitelist</code></li>
</ul>
<p>The following keys require an integer representing a maximum number of failures</p>
<ul>
<li><code>mark_as_brute</code></li>
<li><code>max_failures</code></li>
<li><code>max_failures_byip</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/set_cphulk_config_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_cphulk_config_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:R2adn8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adn8q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adn8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adn8q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adn8q:0" aria-labelledby="tab:R2adn8q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_cphulk_config_key <span class="token assign-left variable">key</span><span class="token operator">=</span>is_enabled <span class="token assign-left variable">value</span><span class="token operator">=</span><span class="token number">1</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adn8q:1" aria-labelledby="tab:R2adn8q: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:R2edn8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edn8q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edn8q:0" aria-labelledby="tab:R2edn8q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cphulk_config"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"block_brute_force_with_firewall"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"block_excessive_brute_force_with_firewall"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"brute_force_period_mins"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"brute_force_period_sec"</span>: <span class="token number">300</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_temp_ban_firewall"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"command_to_run_on_brute_force"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"command_to_run_on_excessive_brute_force"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"country_blacklist"</span>: <span class="token string">"PK,BR"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"country_whitelist"</span>: <span class="token string">"US,AU"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_based_protection"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_brute_force_period_mins"</span>: <span class="token number">15</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_brute_force_period_sec"</span>: <span class="token number">900</span><span class="token punctuation">,</span></div></li><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">"lookback_period_min"</span>: <span class="token number">360</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lookback_time"</span>: <span class="token number">21600</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mark_as_brute"</span>: <span class="token number">30</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_failures"</span>: <span class="token number">30</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_failures_byip"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_on_brute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_on_root_login"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_on_root_login_for_known_netblock"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username_based_protection"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username_based_protection_for_root"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username_based_protection_local_origin"</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">"metadata"</span>: <button class="collapser" aria-label="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">"set_cphulk_config_key"</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/Web-Log-Retention" data-section-id="tag/Web-Log-Retention" 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/Web-Log-Retention" aria-label="tag/Web-Log-Retention"></a>Web Log Retention</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>The Web Log Retention module for WHM API 1.</p>
"><p>The Web Log Retention module for WHM API 1.</p>
</div></div></div><div id="tag/Web-Log-Retention/operation/list_accounts_retention" data-section-id="tag/Web-Log-Retention/operation/list_accounts_retention" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_accounts_retention" id="operation/list_accounts_retention" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Web-Log-Retention/operation/list_accounts_retention" aria-label="tag/Web-Log-Retention/operation/list_accounts_retention"></a>List accounts' web log retention settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>List each cPanel account&#39;s web server log retention preference alongside the server default.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>List each cPanel account's web server log retention preference alongside the server default.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_accounts_retention</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_accounts_retention</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99r9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99r9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99r9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99r9a:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99r9a:0" aria-labelledby="tab:R99r9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_accounts_retention
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99r9a:1" aria-labelledby="tab:R99r9a: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:R9pr9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pr9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pr9a:0" aria-labelledby="tab:R9pr9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_retention"</span>: <span class="token number">14</span><span class="token punctuation">,</span></div></li><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"alice"</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">"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 boolean">false</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">"metadata"</span>: <button class="collapser" aria-label="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">"list_accounts_retention"</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/cPanel-Account-Mail-Management" data-section-id="tag/cPanel-Account-Mail-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-Mail-Management" aria-label="tag/cPanel-Account-Mail-Management"></a>cPanel Account Mail Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Mail / cPanel Account Mail Management</p>
"><p>Mail / cPanel Account Mail Management</p>
</div></div></div><div id="tag/cPanel-Account-Mail-Management/operation/unsuspend_outgoing_email" data-section-id="tag/cPanel-Account-Mail-Management/operation/unsuspend_outgoing_email" class="sc-dntaoT ceciOs"><div data-section-id="operation/unsuspend_outgoing_email" id="operation/unsuspend_outgoing_email" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Mail-Management/operation/unsuspend_outgoing_email" aria-label="tag/cPanel-Account-Mail-Management/operation/unsuspend_outgoing_email"></a>Unsuspend account outgoing email<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function unsuspends outgoing email for a cPanel account&#39;s users.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function unsuspends outgoing email for a cPanel account's users.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=example</span></div><div><div html="<p>The cPanel account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>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="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">/unsuspend_outgoing_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/unsuspend_outgoing_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:Rii339q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii339q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii339q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii339q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii339q:0" aria-labelledby="tab:Rii339q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
unsuspend_outgoing_email <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:Rii339q:1" aria-labelledby="tab:Rii339q: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:Rji339q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji339q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji339q:0" aria-labelledby="tab:Rji339q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"unsuspend_outgoing_email"</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/cPanel-Account-Mail-Management/operation/list_pops_for" data-section-id="tag/cPanel-Account-Mail-Management/operation/list_pops_for" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_pops_for" id="operation/list_pops_for" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Mail-Management/operation/list_pops_for" aria-label="tag/cPanel-Account-Mail-Management/operation/list_pops_for"></a>Return cPanel account's email accounts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists a cPanel account’s email accounts. To prevent falsified data or symlink exploitation, the function uses the specified cPanel account user, rather than <code>root</code> user, to read data from the user’s home directory. The system compares the collected data from the user’s home directory to a server-wide domains list. The comparison of the data validates whether you can trust the data.</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 lists a cPanel account’s email accounts. To prevent falsified data or symlink exploitation, the function uses the specified cPanel account user, rather than <code>root</code> user, to read data from the user’s home directory. The system compares the collected data from the user’s home directory to a server-wide domains list. The comparison of the data validates whether you can trust the data.</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="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</span></div><div><div html="<p>The cPanel account user for which to list all owned email accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account user for which to list all owned email accounts.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_pops_for</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_pops_for</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii539q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii539q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii539q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii539q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii539q:0" aria-labelledby="tab:Rii539q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_pops_for <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:Rii539q:1" aria-labelledby="tab:Rii539q: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:Rji539q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji539q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji539q:0" aria-labelledby="tab:Rji539q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"pops"</span>: <button class="collapser" aria-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@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">"metadata"</span>: <button class="collapser" aria-label="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">"list_pops_for"</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/cPanel-Account-Mail-Management/operation/get_user_email_forward_destination" data-section-id="tag/cPanel-Account-Mail-Management/operation/get_user_email_forward_destination" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_user_email_forward_destination" id="operation/get_user_email_forward_destination" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Mail-Management/operation/get_user_email_forward_destination" aria-label="tag/cPanel-Account-Mail-Management/operation/get_user_email_forward_destination"></a>Return cPanel account forward destination<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the destination to which the system forwards a system account&#39;s email.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Usually, the system sends notices about the server&#39;s problems and activity to the <code>root</code> account.</li>
<li>If you do <strong>not</strong> use the <code>suexec</code> module, the <code>nobody</code> user receives bounce messages from email that CGI scripts send.</li>
</ul>
<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</a> role, the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the destination to which the system forwards a system account's email.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Usually, the system sends notices about the server's problems and activity to the <code>root</code> account.</li>
<li>If you do <strong>not</strong> use the <code>suexec</code> module, the <code>nobody</code> user receives bounce messages from email that CGI scripts send.</li>
</ul>
<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</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="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=root</span></div><div><div html="<p>The system account name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The system 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_user_email_forward_destination</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_user_email_forward_destination</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii739q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii739q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii739q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii739q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii739q:0" aria-labelledby="tab:Rii739q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_user_email_forward_destination <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'root'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii739q:1" aria-labelledby="tab:Rii739q: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:Rji739q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji739q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji739q:0" aria-labelledby="tab:Rji739q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"forward_to"</span>: <button class="collapser" aria-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@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">"metadata"</span>: <button class="collapser" aria-label="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">"get_user_email_forward_destination"</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/cPanel-Account-Mail-Management/operation/set_user_email_forward_destination" data-section-id="tag/cPanel-Account-Mail-Management/operation/set_user_email_forward_destination" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_user_email_forward_destination" id="operation/set_user_email_forward_destination" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Mail-Management/operation/set_user_email_forward_destination" aria-label="tag/cPanel-Account-Mail-Management/operation/set_user_email_forward_destination"></a>Update cPanel account email forward destination<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the destination to which the system forwards a system account&#39;s email.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>Usually, the system sends notices about the server&#39;s problems and activity to the <code>root</code> account.</li>
<li>If you do <strong>not</strong> use the <code>suexec</code> module, the <code>nobody</code> user receives bounce messages from email that CGI scripts send.</li>
</ul>
<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 sets the destination to which the system forwards a system account's email.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>Usually, the system sends notices about the server's problems and activity to the <code>root</code> account.</li>
<li>If you do <strong>not</strong> use the <code>suexec</code> module, the <code>nobody</code> user receives bounce messages from email that CGI scripts send.</li>
</ul>
<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="forward_to" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">forward_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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">forward_to=user</span></div><div><div html="<p>The system account name or email address to which you wish to forward email.</p>
<p><strong>Note:</strong></p>
<p>To forward messages to multiple accounts or email addresses, use a comma-separated list.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The system account name or email address to which you wish to forward email.</p>
<p><strong>Note:</strong></p>
<p>To forward messages to multiple accounts or email addresses, use a comma-separated list.</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=root</span></div><div><div html="<p>The system account name to forward.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The system account name to forward.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/set_user_email_forward_destination</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_user_email_forward_destination</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii939q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii939q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii939q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii939q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii939q:0" aria-labelledby="tab:Rii939q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_user_email_forward_destination <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'root'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">forward_to</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:Rii939q:1" aria-labelledby="tab:Rii939q: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:Rji939q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji939q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji939q:0" aria-labelledby="tab:Rji939q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_user_email_forward_destination"</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/cPanel-Account-Mail-Management/operation/get_unique_recipient_count_per_sender_for_user" data-section-id="tag/cPanel-Account-Mail-Management/operation/get_unique_recipient_count_per_sender_for_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_unique_recipient_count_per_sender_for_user" id="operation/get_unique_recipient_count_per_sender_for_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Mail-Management/operation/get_unique_recipient_count_per_sender_for_user" aria-label="tag/cPanel-Account-Mail-Management/operation/get_unique_recipient_count_per_sender_for_user"></a>Return cPanel account unique email recipients<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function gets the number of unique recipients that a system user sent mail to within a period of time. It groups this data by each of the user&#39;s email accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function gets the number of unique recipients that a system user sent mail to within a period of time. It groups this data by each of the 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=""><td kind="field" title="end_time" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">end_time</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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_time=1550923200</span></div><div><div html="<p>An end time to query.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An end time to query.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="start_time" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">start_time</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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_time=1550872800</span></div><div><div html="<p>A start time to query.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A start time to query.</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 system user&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The system user'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_unique_recipient_count_per_sender_for_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_unique_recipient_count_per_sender_for_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:Riib39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riib39q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riib39q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riib39q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riib39q:0" aria-labelledby="tab:Riib39q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_unique_recipient_count_per_sender_for_user <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">start_time</span><span class="token operator">=</span><span class="token string">'1550872800'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">end_time</span><span class="token operator">=</span><span class="token string">'1550923200'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riib39q:1" aria-labelledby="tab:Riib39q: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:Rjib39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjib39q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjib39q:0" aria-labelledby="tab:Rjib39q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"sender"</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">"unique_recipient_count"</span>: <span class="token number">51</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_unique_recipient_count_per_sender_for_user"</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/cPanel-Account-Mail-Management/operation/get_unique_sender_recipient_count_per_user" data-section-id="tag/cPanel-Account-Mail-Management/operation/get_unique_sender_recipient_count_per_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_unique_sender_recipient_count_per_user" id="operation/get_unique_sender_recipient_count_per_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Mail-Management/operation/get_unique_sender_recipient_count_per_user" aria-label="tag/cPanel-Account-Mail-Management/operation/get_unique_sender_recipient_count_per_user"></a>Return all cPanel account unique email recipients<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function gets a count of the email addresses that each system account sent mail to within a specific period of time. It groups the data by each system user for all the system&#39;s users.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function gets a count of the email addresses that each system account sent mail to within a specific period of time. It groups the data by each system user for all the system's users.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="end_time" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">end_time</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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_time=1551192100</span></div><div><div html="<p>An end time to query.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An end time to query.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="start_time" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">start_time</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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_time=1550702383</span></div><div><div html="<p>A start time to query.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A start time 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_unique_sender_recipient_count_per_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_unique_sender_recipient_count_per_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:Riid39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riid39q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riid39q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riid39q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riid39q:0" aria-labelledby="tab:Riid39q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_unique_sender_recipient_count_per_user <span class="token punctuation">\</span>
<span class="token assign-left variable">start_time</span><span class="token operator">=</span><span class="token string">'1550702383'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">end_time</span><span class="token operator">=</span><span class="token string">'1551192100'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riid39q:1" aria-labelledby="tab:Riid39q: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:Rjid39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjid39q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjid39q:0" aria-labelledby="tab:Rjid39q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"unique_sender_recipient_count"</span>: <span class="token number">120</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></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">"command"</span>: <span class="token string">"get_unique_sender_recipient_count_per_user"</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/cPanel-Account-Mail-Management/operation/suspend_outgoing_email" data-section-id="tag/cPanel-Account-Mail-Management/operation/suspend_outgoing_email" class="sc-dntaoT ceciOs"><div data-section-id="operation/suspend_outgoing_email" id="operation/suspend_outgoing_email" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Mail-Management/operation/suspend_outgoing_email" aria-label="tag/cPanel-Account-Mail-Management/operation/suspend_outgoing_email"></a>Suspend cPanel account outgoing email<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets Exim&#39;s queue to suspend and force failure for email that a user sends to an external address.</p>
<p><strong>Note:</strong></p>
<p> If mail for a cPanel user&#39;s account is suspended, the system will reject their email before the mail server puts it in queue.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets Exim's queue to suspend and force failure for email that a user sends to an external address.</p>
<p><strong>Note:</strong></p>
<p> If mail for a cPanel user's account is suspended, the system will reject their email before the mail server puts it in 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="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</span></div><div><div html="<p>The cPanel account.</p>
<p><strong>Note</strong></p>
<p>You <strong>cannot</strong> suspend the <code>root</code> user&#39;s outgoing email with this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account.</p>
<p><strong>Note</strong></p>
<p>You <strong>cannot</strong> suspend the <code>root</code> user's outgoing email with this 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="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">/suspend_outgoing_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/suspend_outgoing_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:Riif39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riif39q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riif39q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riif39q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riif39q:0" aria-labelledby="tab:Riif39q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
suspend_outgoing_email <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:Riif39q:1" aria-labelledby="tab:Riif39q: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:Rjif39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjif39q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjif39q:0" aria-labelledby="tab:Rjif39q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"suspend_outgoing_email"</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/cPanel-Account-Mail-Management/operation/expunge_messages_for_mailbox_guid" data-section-id="tag/cPanel-Account-Mail-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/cPanel-Account-Mail-Management/operation/expunge_messages_for_mailbox_guid" aria-label="tag/cPanel-Account-Mail-Management/operation/expunge_messages_for_mailbox_guid"></a>Remove email account messages by mailbox GUID<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes mail messages from a cPanel 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 removes mail messages from a cPanel 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=""><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&#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><strong>Note:</strong></p>
<p>To find the mailbox GUID, use the WHM API 1 - <code>get_mailbox_status</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mailbox's globally unique identifier (GUID).</p>
<p><strong>Note:</strong></p>
<p>To find the mailbox GUID, use the WHM API 1 - <code>get_mailbox_status</code> function.</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 Dovecot search query to select which messages you wish to remove from the mailbox. For more information, read <a href="http://wiki2.dovecot.org/Tools/Doveadm/SearchQuery">Dovecot&#39;s Search Query</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Dovecot search query to select which messages you wish to remove from the mailbox. For more information, read <a href="http://wiki2.dovecot.org/Tools/Doveadm/SearchQuery">Dovecot's 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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:Riih39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riih39q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riih39q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riih39q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riih39q:0" aria-labelledby="tab:Riih39q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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">'user@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:Riih39q:1" aria-labelledby="tab:Riih39q: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:Rjih39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjih39q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjih39q:0" aria-labelledby="tab:Rjih39q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"expunge_messages_for_mailbox_guid"</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/cPanel-Account-Mail-Management/operation/expunge_mailbox_messages" data-section-id="tag/cPanel-Account-Mail-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/cPanel-Account-Mail-Management/operation/expunge_mailbox_messages" aria-label="tag/cPanel-Account-Mail-Management/operation/expunge_mailbox_messages"></a>Remove email account messages by Dovecot query<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes mail messages from a cPanel account that you select with a query.</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 removes mail messages from a cPanel account that you select with a query.</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="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>An email account that exists on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An email account that exists on the server.</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</span></div><div><div html="<p>A mailbox name on the account.</p>
<p><strong>Note:</strong></p>
<p> 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 WHM API 1 <code>expunge_messages_for_mailbox_guid</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A mailbox name on the account.</p>
<p><strong>Note:</strong></p>
<p> 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 WHM API 1 <code>expunge_messages_for_mailbox_guid</code> function.</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>A <a href="http://wiki2.dovecot.org/Tools/Doveadm/SearchQuery">Dovecot search query</a> to select which messages you wish to remove from the mailbox.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A <a href="http://wiki2.dovecot.org/Tools/Doveadm/SearchQuery">Dovecot search query</a> 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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:Riij39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riij39q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riij39q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riij39q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riij39q:0" aria-labelledby="tab:Riij39q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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">'user@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'</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:Riij39q:1" aria-labelledby="tab:Riij39q: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:Rjij39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjij39q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjij39q:0" aria-labelledby="tab:Rjij39q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"expunge_mailbox_messages"</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/cPanel-Account-Mail-Management/operation/get_mailbox_status" data-section-id="tag/cPanel-Account-Mail-Management/operation/get_mailbox_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_mailbox_status" id="operation/get_mailbox_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Mail-Management/operation/get_mailbox_status" aria-label="tag/cPanel-Account-Mail-Management/operation/get_mailbox_status"></a>Return cPanel account mailboxes status by name<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the status of a cPanel&#39;s mail account&#39;s mailboxes.</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 lists the status of a cPanel's mail account's mailboxes.</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="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><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td 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=user@example.com</span></div><div><div html="<p>An email account or cPanel account&#39;s username.</p>
<p><strong>Note:</strong></p>
<p><code>_mainaccount</code> is an alias representing the cPanel user&#39;s mailbox (for example, `<a href="mailto:&#x5f;&#x6d;&#97;&#105;&#x6e;&#x61;&#99;&#x63;&#111;&#x75;&#x6e;&#116;&#64;&#x65;&#120;&#97;&#x6d;&#x70;&#108;&#x65;&#x2e;&#x63;&#x6f;&#x6d;">&#x5f;&#x6d;&#97;&#105;&#x6e;&#x61;&#99;&#x63;&#111;&#x75;&#x6e;&#116;&#64;&#x65;&#120;&#97;&#x6d;&#x70;&#108;&#x65;&#x2e;&#x63;&#x6f;&#x6d;</a> represents the example mailbox.)</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An email account or cPanel account's username.</p>
<p><strong>Note:</strong></p>
<p><code>_mainaccount</code> is an alias representing the cPanel user's mailbox (for example, `<a href="mailto:_mainaccount@example.com">_mainaccount@example.com</a> represents the example 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_mailbox_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_mailbox_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:Riil39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riil39q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riil39q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riil39q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riil39q:0" aria-labelledby="tab:Riil39q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_mailbox_status <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:Riil39q:1" aria-labelledby="tab:Riil39q: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:Rjil39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjil39q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjil39q:0" aria-labelledby="tab:Rjil39q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"INBOX"</span>: <button class="collapser" aria-label="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">"messages"</span>: <span class="token number">42000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">42</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"INBOX.Drafts"</span>: <button class="collapser" aria-label="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">"messages"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">522</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"INBOX.Sent"</span>: <button class="collapser" aria-label="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">"messages"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">56</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"INBOX.Trash"</span>: <button class="collapser" aria-label="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">"messages"</span>: <span class="token number">2001</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">5643</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"INBOX.angel_face@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">"guid"</span>: <span class="token string">"11234560f0c58d158c92a000044f0d23"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">1524</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"INBOX.marla_singer@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">"guid"</span>: <span class="token string">"1234560f0c58d158c92a000044f0d230"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</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">"INBOX.narrator@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">"guid"</span>: <span class="token string">"11111234560f0c58d158c92a000044f0"</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"INBOX.robert_paulsen@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">"guid"</span>: <span class="token string">"111111111234560f0c58d158c92a0001"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">2222</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"INBOX.tyler_durden@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">"guid"</span>: <span class="token string">"111234560f0c58d158c92a000044f0d2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token number">55</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">12244</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"get_mailbox_status"</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/cPanel-Account-Mail-Management/operation/get_mailbox_status_list" data-section-id="tag/cPanel-Account-Mail-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/cPanel-Account-Mail-Management/operation/get_mailbox_status_list" aria-label="tag/cPanel-Account-Mail-Management/operation/get_mailbox_status_list"></a>Return cPanel account mailboxes status list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the status of a cPanel&#39;s mail account&#39;s mailboxes.</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 status of a cPanel's mail account's mailboxes.</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="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 or 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&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:Riin39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riin39q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riin39q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riin39q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riin39q:0" aria-labelledby="tab:Riin39q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:Riin39q:1" aria-labelledby="tab:Riin39q: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:Rjin39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjin39q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjin39q:0" aria-labelledby="tab:Rjin39q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"mailboxes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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></ul><span class="token punctuation">]</span></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">"command"</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">"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/cPanel-Account-Mail-Management/operation/emailtrack_search" data-section-id="tag/cPanel-Account-Mail-Management/operation/emailtrack_search" class="sc-dntaoT ceciOs"><div data-section-id="operation/emailtrack_search" id="operation/emailtrack_search" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Mail-Management/operation/emailtrack_search" aria-label="tag/cPanel-Account-Mail-Management/operation/emailtrack_search"></a>Return email delivery records by search criteria<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves email delivery records.</p>
<p><strong>Warning:</strong></p>
<ul>
<li><p>On most servers, this function returns a large amount of output. We <strong>strongly</strong>
recommend that you <a href="https://go.cpanel.net/WHMAPI1FilterOutput">filter</a> and
<a href="https://go.cpanel.net/WHMAPI1SortOutput">sort</a> the output.</p>
</li>
<li><p>The following example uses the filter and sort options:</p>
<p><code>https://hostname.example.com:2087/cpsess##########/json-api/emailtrack_search?api.version=1&amp;api.filter.enable=1&amp;api.filter.a.field=sendunixtime&amp;api.filter.a.arg0=1628889719&amp;api.filter.a.type=gt&amp;api.filter.b.field=sendunixtime&amp;api.filter.b.arg0=1629847321&amp;api.filter.b.type=lt&amp;api.sort.enable=1&amp;api.sort.a.field=sendunixtime&amp;api.sort.a.reverse=0&amp;api.chunk.enable=1&amp;api.chunk.size=25&amp;api.chunk.start=1&amp;success=1</code></p>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves email delivery records.</p>
<p><strong>Warning:</strong></p>
<ul>
<li><p>On most servers, this function returns a large amount of output. We <strong>strongly</strong>
recommend that you <a href="https://go.cpanel.net/WHMAPI1FilterOutput">filter</a> and
<a href="https://go.cpanel.net/WHMAPI1SortOutput">sort</a> the output.</p>
</li>
<li><p>The following example uses the filter and sort options:</p>
<p><code>https://hostname.example.com:2087/cpsess##########/json-api/emailtrack_search?api.version=1&api.filter.enable=1&api.filter.a.field=sendunixtime&api.filter.a.arg0=1628889719&api.filter.a.type=gt&api.filter.b.field=sendunixtime&api.filter.b.arg0=1629847321&api.filter.b.type=lt&api.sort.enable=1&api.sort.a.field=sendunixtime&api.sort.a.reverse=0&api.chunk.enable=1&api.chunk.size=25&api.chunk.start=1&success=1</code></p>
</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="defer" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">defer</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">defer=0</span></div><div><div html="<p>Whether to return delivery deferral events.</p>
<ul>
<li><code>1</code> — Return delivery deferral events.</li>
<li><code>0</code> — Do not return delivery deferral events.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return delivery deferral events.</p>
<ul>
<li><code>1</code> — Return delivery deferral events.</li>
<li><code>0</code> — Do not return delivery deferral events.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="deliverytype" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">deliverytype</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"all"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"remote"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"local"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">deliverytype=all</span></div><div><div html="<p>The type of delivery records to retrieve.</p>
<ul>
<li><code>all</code> — Retrieve all delivery records.</li>
<li><code>remote</code> — Retrieve remote delivery records.</li>
<li><code>local</code> — Retrieve local delivery records.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of delivery records to retrieve.</p>
<ul>
<li><code>all</code> — Retrieve all delivery records.</li>
<li><code>remote</code> — Retrieve remote delivery records.</li>
<li><code>local</code> — Retrieve local delivery records.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="failure" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">failure</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">failure=0</span></div><div><div html="<p>Whether to return delivery failure events.</p>
<ul>
<li><code>1</code> — Return delivery failure events.</li>
<li><code>0</code> — Do not return delivery failure events.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return delivery failure events.</p>
<ul>
<li><code>1</code> — Return delivery failure events.</li>
<li><code>0</code> — Do not return delivery failure events.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="inprogress" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">inprogress</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">inprogress=0</span></div><div><div html="<p>Whether to return delivery attempts in progress.</p>
<ul>
<li><code>1</code> — Return delivery attempts in progress.</li>
<li><code>0</code> — Do not return delivery attempts in progress.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return delivery attempts in progress.</p>
<ul>
<li><code>1</code> — Return delivery attempts in progress.</li>
<li><code>0</code> — Do not return delivery attempts in progress.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_results_by_type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">max_results_by_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">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">max_results_by_type=3</span></div><div><div html="<p>The number of results to return for each type.</p>
<p><strong>Note</strong></p>
<p>If you set this parameter to <code>0</code>, the function returns unlimited results.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of results to return for each type.</p>
<p><strong>Note</strong></p>
<p>If you set this parameter to <code>0</code>, the function returns unlimited results.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="success" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">success</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">success=0</span></div><div><div html="<p>Whether to return successful delivery attempts.</p>
<ul>
<li><code>1</code> — Return successful delivery attempts.</li>
<li><code>0</code> — Do not return successful delivery attempts.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return successful delivery attempts.</p>
<ul>
<li><code>1</code> — Return successful delivery attempts.</li>
<li><code>0</code> — Do not return successful delivery 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/emailtrack_search</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/emailtrack_search</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riip39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riip39q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riip39q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riip39q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riip39q:0" aria-labelledby="tab:Riip39q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
emailtrack_search
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riip39q:1" aria-labelledby="tab:Riip39q: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:Rjip39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjip39q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjip39q:0" aria-labelledby="tab:Rjip39q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"actiontime"</span>: <span class="token string">"2012-02-06T14:17:51"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"actionunixtime"</span>: <span class="token number">1328559471</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deliveredto"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deliverydomain"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deliveryuser"</span>: <span class="token keyword">null</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">"host"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"Domain example.com has exceeded the max defers and failures per hour (5/5 (100%)) allowed. Message discarded."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msgid"</span>: <span class="token string">"1RuV0Z-0005NR-BN"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recipient"</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">"router"</span>: <span class="token string">"enforce_mail_permissions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sender"</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">"senderauth"</span>: <span class="token string">"localuser"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"senderhost"</span>: <span class="token string">"localhost"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"senderip"</span>: <span class="token string">"127.0.0.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sendunixtime"</span>: <span class="token number">1328559471</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">1653</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spamscore"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"transport"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"transport_is_remote"</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">"success"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"cpanel1"</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">"metadata"</span>: <button class="collapser" aria-label="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">"emailtrack_search"</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/cPanel-Account-Mail-Management/operation/emailtrack_user_stats" data-section-id="tag/cPanel-Account-Mail-Management/operation/emailtrack_user_stats" class="sc-dntaoT ceciOs"><div data-section-id="operation/emailtrack_user_stats" id="operation/emailtrack_user_stats" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Mail-Management/operation/emailtrack_user_stats" aria-label="tag/cPanel-Account-Mail-Management/operation/emailtrack_user_stats"></a>Return all cPanel accounts email tracking statistics<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves email tracking statistics for each user.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves email tracking statistics for each 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="deliverytype" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">deliverytype</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"remote"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"remote-or-faildefer"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"local"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">deliverytype=remote</span></div><div><div html="<p>The type of delivery to query. If you do not specify a value,
this function returns all types.</p>
<ul>
<li><code>remote</code></li>
<li><code>remote-or-faildefer</code></li>
<li><code>local</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of delivery to query. If you do not specify a value,
this function returns all types.</p>
<ul>
<li><code>remote</code></li>
<li><code>remote-or-faildefer</code></li>
<li><code>local</code></li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="endtime" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">endtime</span></td><td class="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">endtime=1471552781</span></div><div><div html="<p>The end time of the search window.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The end time of the search window.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="sender" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">sender</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">sender=username@example.com</span></div><div><div html="<p>The sender&#39;s email address. If you do not specify a value, this function returns entries for mail from all senders.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The sender's email address. If you do not specify a value, this function returns entries for mail from all senders.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="starttime" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">starttime</span></td><td class="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">0</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">starttime=1371552781</span></div><div><div html="<p>The start time of the search window.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The start time of the search window.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/emailtrack_user_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/emailtrack_user_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:Riir39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riir39q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riir39q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riir39q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riir39q:0" aria-labelledby="tab:Riir39q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
emailtrack_user_stats
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riir39q:1" aria-labelledby="tab:Riir39q: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:Rjir39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjir39q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjir39q:0" aria-labelledby="tab:Rjir39q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"DEFERCOUNT"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DEFERFAILCOUNT"</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">"FAILCOUNT"</span>: <span class="token number">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">"PRIMARY_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">"REACHED_MAXDEFERFAIL"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"REACHED_MAXEMAILS"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"SENDCOUNT"</span>: <span class="token number">14</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"SUCCESSCOUNT"</span>: <span class="token number">14</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"TOTALSIZE"</span>: <span class="token number">27444</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></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">"metadata"</span>: <button class="collapser" aria-label="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">"emailtrack_user_stats"</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/cPanel-Account-Mail-Management/operation/emailtrack_stats" data-section-id="tag/cPanel-Account-Mail-Management/operation/emailtrack_stats" class="sc-dntaoT ceciOs"><div data-section-id="operation/emailtrack_stats" id="operation/emailtrack_stats" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Mail-Management/operation/emailtrack_stats" aria-label="tag/cPanel-Account-Mail-Management/operation/emailtrack_stats"></a>Return cPanel account email tracking statistics<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves email tracking statistics.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves email tracking 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="deliverytype" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">deliverytype</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"remote"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"remote-or-faildefer"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"local"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">deliverytype=remote</span></div><div><div html="<p>The type of delivery to query. If you do not specify a value,
this function returns all types.</p>
<ul>
<li><code>remote</code></li>
<li><code>remote-or-faildefer</code></li>
<li><code>local</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of delivery to query. If you do not specify a value,
this function returns all types.</p>
<ul>
<li><code>remote</code></li>
<li><code>remote-or-faildefer</code></li>
<li><code>local</code></li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="endtime" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">endtime</span></td><td class="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">endtime=1471552781</span></div><div><div html="<p>The end time of the search window. This parameter defaults to the current time.</p>
<p><strong>Note</strong></p>
<p>You can also call this the <code>enddate</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The end time of the search window. This parameter defaults to the current time.</p>
<p><strong>Note</strong></p>
<p>You can also call this the <code>enddate</code> parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="nosize" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nosize</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">nosize=0</span></div><div><div html="<p>Whether to return the <code>TOTALSIZE</code> parameter.</p>
<ul>
<li>1 — Do <strong>not</strong> return.</li>
<li>0 — Return.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return the <code>TOTALSIZE</code> parameter.</p>
<ul>
<li>1 — Do <strong>not</strong> return.</li>
<li>0 — Return.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="nosuccess" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nosuccess</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">nosuccess=0</span></div><div><div html="<p>Whether to return the <code>SUCCESSCOUNT</code> parameter.</p>
<ul>
<li>1 — Do <strong>not</strong> return.</li>
<li>0 — Return.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return the <code>SUCCESSCOUNT</code> parameter.</p>
<ul>
<li>1 — Do <strong>not</strong> return.</li>
<li>0 — Return.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="starttime" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">starttime</span></td><td class="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">0</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">starttime=1371552781</span></div><div><div html="<p>The start time of the search window.</p>
<p><strong>Note</strong></p>
<p>You can also call this the <code>startdate</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The start time of the search window.</p>
<p><strong>Note</strong></p>
<p>You can also call this the <code>startdate</code> parameter.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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 cPanel username to query. If you do not specify a value, the function retrieves statistics for all of the server&#39;s accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel username to query. If you do not specify a value, the function retrieves statistics for all of the server's accounts.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/emailtrack_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/emailtrack_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:Riit39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riit39q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riit39q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riit39q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riit39q:0" aria-labelledby="tab:Riit39q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
emailtrack_stats
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riit39q:1" aria-labelledby="tab:Riit39q: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:Rjit39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjit39q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjit39q:0" aria-labelledby="tab:Rjit39q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"DEFERCOUNT"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DEFERFAILCOUNT"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FAILCOUNT"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"INPROGRESSCOUNT"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"SENDCOUNT"</span>: <span class="token number">14</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"SUCCESSCOUNT"</span>: <span class="token number">14</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"TOTALSIZE"</span>: <span class="token number">27444</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">"metadata"</span>: <button class="collapser" aria-label="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">"emailtrack_stats"</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/cPanel-Account-Mail-Management/operation/release_outgoing_email" data-section-id="tag/cPanel-Account-Mail-Management/operation/release_outgoing_email" class="sc-dntaoT ceciOs"><div data-section-id="operation/release_outgoing_email" id="operation/release_outgoing_email" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Mail-Management/operation/release_outgoing_email" aria-label="tag/cPanel-Account-Mail-Management/operation/release_outgoing_email"></a>Release cPanel account queued outgoing emails<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function releases outgoing email in the email queue for a single cPanel account user.</p>
<p><strong>Note:</strong></p>
<p>If mail for a cPanel user&#39;s account is suspended, the system will reject their email before the mail server puts it in queue.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function releases outgoing email in the email queue for a single cPanel account user.</p>
<p><strong>Note:</strong></p>
<p>If mail for a cPanel user's account is suspended, the system will reject their email before the mail server puts it in 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="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</span></div><div><div html="<p>The cPanel account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>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="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">/release_outgoing_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/release_outgoing_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:Riiv39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiv39q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiv39q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiv39q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiv39q:0" aria-labelledby="tab:Riiv39q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
release_outgoing_email <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:Riiv39q:1" aria-labelledby="tab:Riiv39q: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:Rjiv39q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiv39q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiv39q:0" aria-labelledby="tab:Rjiv39q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"release_outgoing_email"</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/cPanel-Account-Mail-Management/operation/hold_outgoing_email" data-section-id="tag/cPanel-Account-Mail-Management/operation/hold_outgoing_email" class="sc-dntaoT ceciOs"><div data-section-id="operation/hold_outgoing_email" id="operation/hold_outgoing_email" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Mail-Management/operation/hold_outgoing_email" aria-label="tag/cPanel-Account-Mail-Management/operation/hold_outgoing_email"></a>Add cPanel account to outbound email hold queue<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets Exim&#39;s queue to hold email that a user sends to an external address.</p>
<p><strong>Note:</strong></p>
<p> If mail for a cPanel user&#39;s account is suspended, the system will reject their email before the mail server puts it in the queue.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets Exim's queue to hold email that a user sends to an external address.</p>
<p><strong>Note:</strong></p>
<p> If mail for a cPanel user's account is suspended, the system will reject their email before the mail server puts it in the 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="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</span></div><div><div html="<p>The cPanel account.</p>
<p><strong>Note</strong></p>
<p>You <strong>cannot</strong> suspend the root user&#39;s outgoing email with this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account.</p>
<p><strong>Note</strong></p>
<p>You <strong>cannot</strong> suspend the root user's outgoing email with this 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="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">/hold_outgoing_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/hold_outgoing_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:Rij139q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij139q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij139q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij139q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij139q:0" aria-labelledby="tab:Rij139q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
hold_outgoing_email <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:Rij139q:1" aria-labelledby="tab:Rij139q: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:Rjj139q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj139q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj139q:0" aria-labelledby="tab:Rjj139q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"hold_outgoing_email"</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/cPanel-Account-Mail-Management/operation/terminate_cpuser_mailbox_sessions" data-section-id="tag/cPanel-Account-Mail-Management/operation/terminate_cpuser_mailbox_sessions" class="sc-dntaoT ceciOs"><div data-section-id="operation/terminate_cpuser_mailbox_sessions" id="operation/terminate_cpuser_mailbox_sessions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Mail-Management/operation/terminate_cpuser_mailbox_sessions" aria-label="tag/cPanel-Account-Mail-Management/operation/terminate_cpuser_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><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><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=username</span></div><div><div html="<p>The cPanel account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="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">/terminate_cpuser_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/terminate_cpuser_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:Rij339q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij339q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij339q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij339q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij339q:0" aria-labelledby="tab:Rij339q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
terminate_cpuser_mailbox_sessions <span class="token punctuation">\</span>
<span class="token assign-left variable">username</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:Rij339q:1" aria-labelledby="tab:Rij339q: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:Rjj339q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj339q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj339q:0" aria-labelledby="tab:Rjj339q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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_cpuser_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/Mail-DNS-Settings" data-section-id="tag/Mail-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/Mail-DNS-Settings" aria-label="tag/Mail-DNS-Settings"></a>Mail DNS Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Mail / Mail DNS Settings</p>
"><p>Mail / Mail DNS Settings</p>
</div></div></div><div id="tag/Mail-DNS-Settings/operation/EmailAuth::validate_current_dmarcs" data-section-id="tag/Mail-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/Mail-DNS-Settings/operation/EmailAuth::validate_current_dmarcs" aria-label="tag/Mail-DNS-Settings/operation/EmailAuth::validate_current_dmarcs"></a>Validate DMARC records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves and checks the DMARC record for one or more domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves and checks the 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></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=example.com&domain-3=example3.com</span> -<!-- --> <!-- -->Check the DMARC record for multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com&domain=example2.com&domain=example3.com</span> -<!-- --> <!-- -->Check the DMARC record for multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com</span> -<!-- --> <!-- -->Check the 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>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> parameters.</p>
<p>If you do not include this argument, the system will validate DMARC records for all domains on the server.</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>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> parameters.</p>
<p>If you do not include this argument, the system will validate DMARC records for all domains on the 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99359q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99359q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99359q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99359q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99359q:0" aria-labelledby="tab:R99359q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99359q:1" aria-labelledby="tab:R99359q: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:R9p359q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p359q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p359q:0" aria-labelledby="tab:R9p359q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">""</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><li><div class="hoverable "><button class="collapser" aria-label="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">"error"</span>: <span class="token string">"(XID 4krw35) DNS returned “SERVFAIL” (code 2) in response to the system’s query for “_dmarc.example2.com”’s “TXT” records."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"record"</span>: <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">"DNS_ERROR"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subdomain"</span>: <span class="token string">"_dmarc.example2.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></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">"command"</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">"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/Mail-DNS-Settings/operation/EmailAuth::apply_dmarc" data-section-id="tag/Mail-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/Mail-DNS-Settings/operation/EmailAuth::apply_dmarc" aria-label="tag/Mail-DNS-Settings/operation/EmailAuth::apply_dmarc"></a>Apply a DMARC record to a domain<!-- --> </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></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-1.com domain=example-2.com domain=example-3.com</span> -<!-- --> <!-- -->To apply multiple DMARC records</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> -<!-- --> <!-- -->To apply a single domain DMARC record</li></ul><div><div html="<p>The domain for which to apply the DMARC record.</p>
<p><strong>Note:</strong></p>
<p> To apply multiple domain DMARC records, duplicate the parameter name. For example, use the <code>domain=example-1.com</code>, <code>domain=example-2.com</code>, and <code>domain=example-3.com</code> parameters.</p>
<p> If you do not include this argument, the system applies the DMARC record to <strong>all</strong> domains on the system.</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 apply multiple domain DMARC records, duplicate the parameter name. For example, use the <code>domain=example-1.com</code>, <code>domain=example-2.com</code>, and <code>domain=example-3.com</code> parameters.</p>
<p> If you do not include this argument, the system applies the DMARC record to <strong>all</strong> domains on the system.</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> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">policy=policy="v=DMARC1; p=none;" policy="v=DMARC1; p=reject;" policy="v=DMARC1; p=quarantine;"</span> -<!-- --> <!-- -->To apply multiple DMARC policies, duplicate the policy arguments.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">policy=policy="v=DMARC1;p=reject;pct=100;rua=mailto:postmaster@example.com"</span> -<!-- --> <!-- -->To apply a single DMARC record to domains, specify a single policy.</li></ul><div><div html="<p>The DMARC record to apply to the requested domains.</p>
<p><strong>Note:</strong></p>
<p>When using multiple policies, each policy must have a matching domain.</p>
<p>When using a single policy, it will be applied to all specified domains.</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>When using multiple policies, each policy must have a matching domain.</p>
<p>When using a single policy, it will be applied to all specified domains.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99559q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99559q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99559q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99559q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99559q:0" aria-labelledby="tab:R99559q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99559q:1" aria-labelledby="tab:R99559q: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:R9p559q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p559q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p559q:0" aria-labelledby="tab:R9p559q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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></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">"command"</span>: <span class="token string">"apply_dmarc"</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/Mail-DNS-Settings/operation/EmailAuth::remove_dmarc" data-section-id="tag/Mail-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/Mail-DNS-Settings/operation/EmailAuth::remove_dmarc" aria-label="tag/Mail-DNS-Settings/operation/EmailAuth::remove_dmarc"></a>Remove domains' DMARC records.<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes the DMARC DNS record from a domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes the DMARC DNS record from 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></td><td class="sc-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-1.com domain=example-2.com domain=example-3.com</span> -<!-- --> <!-- -->To remove multiple domain DMARC records</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> -<!-- --> <!-- -->To remove a single domain DMARC record</li></ul><div><div html="<p>The domain for 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.</p>
<p>To remove multiple domain DMARC records, duplicate the parameter name. For example, use the <code>domain=example-1.com</code>, <code>domain=example-2.com</code>, and <code>domain=example-3.com</code> parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for 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.</p>
<p>To remove multiple domain DMARC records, duplicate the parameter name. For example, use the <code>domain=example-1.com</code>, <code>domain=example-2.com</code>, and <code>domain=example-3.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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99759q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99759q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99759q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99759q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99759q:0" aria-labelledby="tab:R99759q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99759q:1" aria-labelledby="tab:R99759q: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:R9p759q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p759q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p759q:0" aria-labelledby="tab:R9p759q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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.exmaple.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></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">"command"</span>: <span class="token string">"remove_dmarc"</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/Mail-DNS-Settings/operation/disable_dkim" data-section-id="tag/Mail-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/Mail-DNS-Settings/operation/disable_dkim" aria-label="tag/Mail-DNS-Settings/operation/disable_dkim"></a>Disable domain's 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-1.com domain=example-2.com domain=example-3.com</span> -<!-- --> <!-- -->To remove multiple domain DKIM records</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> -<!-- --> <!-- -->To remove a single domain DKIM record</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-1.com</code>, <code>domain=example-2.com</code>, and <code>domain=example-3.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-1.com</code>, <code>domain=example-2.com</code>, and <code>domain=example-3.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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99959q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99959q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99959q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99959q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99959q:0" aria-labelledby="tab:R99959q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99959q:1" aria-labelledby="tab:R99959q: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:R9p959q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p959q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p959q:0" aria-labelledby="tab:R9p959q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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=MIGfMAOGCSqGSIb3DQEBAQUAA4GNADCBiLMNOpQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO/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></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">"command"</span>: <span class="token string">"disable_dkim"</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/Mail-DNS-Settings/operation/enable_dkim" data-section-id="tag/Mail-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/Mail-DNS-Settings/operation/enable_dkim" aria-label="tag/Mail-DNS-Settings/operation/enable_dkim"></a>Enable domain's 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>
" 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>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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-1.com domain=example-2.com domain=example-3.com</span> -<!-- --> <!-- -->To enable multiple domain DKIM records</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> -<!-- --> <!-- -->To enable a single domain DKIM record</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 the parameter name. For example, use the <code>domain=example-1.com</code>, <code>domain=example-2.com</code>, and <code>domain=example-3.com parameters</code>.</p>
" 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 the parameter name. For example, use the <code>domain=example-1.com</code>, <code>domain=example-2.com</code>, and <code>domain=example-3.com parameters</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99b59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b59q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b59q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b59q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b59q:0" aria-labelledby="tab:R99b59q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99b59q:1" aria-labelledby="tab:R99b59q: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:R9pb59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb59q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb59q:0" aria-labelledby="tab:R9pb59q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"Installed Keys"</span><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></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">"command"</span>: <span class="token string">"enable_dkim"</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/Mail-DNS-Settings/operation/fetch_dkim_private_keys" data-section-id="tag/Mail-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/Mail-DNS-Settings/operation/fetch_dkim_private_keys" aria-label="tag/Mail-DNS-Settings/operation/fetch_dkim_private_keys"></a>Return domain's DKIM private key<!-- --> </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</a> (PEM) 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</a> (PEM) 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></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-1.com&domain=example-2.com&domain=example-3.com</span> -<!-- --> <!-- -->Query multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> -<!-- --> <!-- -->Query a single domain.</li></ul><div><div html="<p>The queried domain.</p>
<p><strong>Note:</strong></p>
<p> To retrieve multiple domain DKIM keys, increment the parameter name. For example, use the <code>domain-1=example-1.com</code>, <code>domain-2=example-2.com</code>, and <code>domain-3=example-3.com</code> parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The queried domain.</p>
<p><strong>Note:</strong></p>
<p> To retrieve multiple domain DKIM keys, increment the parameter name. For example, use the <code>domain-1=example-1.com</code>, <code>domain-2=example-2.com</code>, and <code>domain-3=example-3.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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99d59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d59q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d59q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d59q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d59q:0" aria-labelledby="tab:R99d59q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99d59q:1" aria-labelledby="tab:R99d59q: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:R9pd59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd59q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd59q:0" aria-labelledby="tab:R9pd59q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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></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">"command"</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">"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/Mail-DNS-Settings/operation/ensure_dkim_keys_exist" data-section-id="tag/Mail-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/Mail-DNS-Settings/operation/ensure_dkim_keys_exist" aria-label="tag/Mail-DNS-Settings/operation/ensure_dkim_keys_exist"></a>Validate domain's DKIM 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>Note:</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>Note:</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></div> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example1.com&domain=example2.com&domain=example3.com</span> -<!-- --> <!-- -->Check the DKIM key validity for multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> -<!-- --> <!-- -->Check the DKIM key validity for 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 domain, duplicate the parameter name. For example, use the <code>domain-1=example.com</code>, <code>domain-2=example2.com</code>, and <code>domain-3=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 domain, duplicate the parameter name. For example, use the <code>domain-1=example.com</code>, <code>domain-2=example2.com</code>, and <code>domain-3=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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99f59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f59q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f59q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f59q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f59q:0" aria-labelledby="tab:R99f59q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99f59q:1" aria-labelledby="tab:R99f59q: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:R9pf59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf59q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf59q:0" aria-labelledby="tab:R9pf59q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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></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">"command"</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">"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/Mail-DNS-Settings/operation/install_spf_records" data-section-id="tag/Mail-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/Mail-DNS-Settings/operation/install_spf_records" aria-label="tag/Mail-DNS-Settings/operation/install_spf_records"></a>Install domain SPF record<!-- --> </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><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-1.com&domain-2=example-2.com&domain-3=example-3.com</span> -<!-- --> <!-- -->Multiple domains</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> -<!-- --> <!-- -->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, increment the parameter name. For example, use the <code>domain-1=example-1.com</code>, <code>domain-2=example-2.com</code>, and <code>domain-3=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, increment the parameter name. For example, use the <code>domain-1=example-1.com</code>, <code>domain-2=example-2.com</code>, and <code>domain-3=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%3Dspf1%20%2Bip4%3A1192.0.2.0%20-all</span></div><div><div html="<p>An SPF record.</p>
<p>You <strong>must</strong> provide this parameter for every <code>domain</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An SPF record.</p>
<p>You <strong>must</strong> provide this parameter for every <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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99h59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h59q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h59q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h59q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h59q:0" aria-labelledby="tab:R99h59q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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%3Dspf1%20%2Bip4%3A1192.0.2.0%20-all'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h59q:1" aria-labelledby="tab:R99h59q: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:R9ph59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph59q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph59q:0" aria-labelledby="tab:R9ph59q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"[REPLACE:TXT@example.com.:v=spf1 ip4:192.0.2.0 -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></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">"command"</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">"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/Mail-DNS-Settings/operation/install_dkim_private_keys" data-section-id="tag/Mail-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/Mail-DNS-Settings/operation/install_dkim_private_keys" aria-label="tag/Mail-DNS-Settings/operation/install_dkim_private_keys"></a>Install existing private key to DKIM record<!-- --> </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>Notes:</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 WHM API 1 <code>enable_dkim</code> function to update the local DNS server&#39;s DNS records.</li>
<li>We recommend that you use the WHM API 1 <code>install_dkim_private_keys</code> and <code>enable_dkim</code> functions in a batch WHM API 1 call.</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>Notes:</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 WHM API 1 <code>enable_dkim</code> function to update the local DNS server's DNS records.</li>
<li>We recommend that you use the WHM API 1 <code>install_dkim_private_keys</code> and <code>enable_dkim</code> functions in a batch WHM API 1 call.</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-1=example-1.com&domain-2=example-2.com&domain-3=example-3.com</span> -<!-- --> <!-- -->The domains for which to install an RSA private key to the local server's DKIM record.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> -<!-- --> <!-- -->The domain for which to install an RSA private key to the local server's DKIM record.</li></ul><div><div html="<p>The domain for which to install an RSA private key to the local server&#39;s DKIM record.</p>
<p><strong>Note:</strong></p>
<p>To install RSA private keys for multiple domains, increment the parameter name. For example, use the <code>domain-1=example-1.com</code>, <code>domain-2=example-2.com</code>, and <code>domain-3=example-3.com</code> parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to install an RSA private key to the local server's DKIM record.</p>
<p><strong>Note:</strong></p>
<p>To install RSA private keys for multiple domains, increment the parameter name. For example, use the <code>domain-1=example-1.com</code>, <code>domain-2=example-2.com</code>, and <code>domain-3=example-3.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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw</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>
<ul>
<li>You <strong>must</strong> provide this parameter for each <code>domain</code> parameter.</li>
<li>To install multiple RSA keys for a domain, increment the parameter name. For example, use the <code>key-1</code>, <code>key-2</code> parameters.
examples:
single:
summary: An RSA key in <a href="https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail">Privacy-Enhanced Mail (PEM)</a> format.
value: key
multiple:
summary: RSA keys in <a href="https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail">Privacy-Enhanced Mail (PEM)</a> format.
value: key-1=KEYKEYKEY&amp;key-2=KEYKEYKEY</li>
</ul>
" 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>
<ul>
<li>You <strong>must</strong> provide this parameter for each <code>domain</code> parameter.</li>
<li>To install multiple RSA keys for a domain, increment the parameter name. For example, use the <code>key-1</code>, <code>key-2</code> parameters.
examples:
single:
summary: An RSA key in <a href="https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail">Privacy-Enhanced Mail (PEM)</a> format.
value: key
multiple:
summary: RSA keys in <a href="https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail">Privacy-Enhanced Mail (PEM)</a> format.
value: key-1=KEYKEYKEY&key-2=KEYKEYKEY</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99j59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j59q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j59q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j59q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j59q:0" aria-labelledby="tab:R99j59q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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.com'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">key</span><span class="token operator">=</span><span class="token string">'AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j59q:1" aria-labelledby="tab:R99j59q: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:R9pj59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj59q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj59q:0" aria-labelledby="tab:R9pj59q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"Installed Keys"</span><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></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">"command"</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">"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/Mail-DNS-Settings/operation/validate_current_dkims" data-section-id="tag/Mail-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/Mail-DNS-Settings/operation/validate_current_dkims" aria-label="tag/Mail-DNS-Settings/operation/validate_current_dkims"></a>Validate 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></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=example.com&domain-3=example3.com</span> -<!-- --> <!-- -->Check the DKIM records for multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com&domain=example2.com&domain=example3.com</span> -<!-- --> <!-- -->Check the DKIM records for multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> -<!-- --> <!-- -->Check the DKIM records for a single domain.</li></ul><div><div html="<p>The domain for which to check the DKIM records.</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> parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to check the DKIM records.</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> 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99l59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99l59q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99l59q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l59q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99l59q:0" aria-labelledby="tab:R99l59q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99l59q:1" aria-labelledby="tab:R99l59q: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:R9pl59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pl59q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pl59q:0" aria-labelledby="tab:R9pl59q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"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">"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><li><div class="hoverable "><button class="collapser" aria-label="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.example2.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) in response to the system’s query for “default._domainkey.example2.com”’s “TXT” 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=MIIBIjAAAgkrhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4mA8NH3BkYvOmB0+ll23U78JesahG8304unKhW+MAm0ZE+i6EWN6iXhUj7FRPvI/6jFRd7qAHCPKFLo5+/PTy8C8eK312tfSnF3N0eucYFbgZ8F8iSRdgrcgEjvJ1vM1uvcUF211yd/e3jxT2Ge4/fmZcTYNjfH3uAuriv61L6pdIwHUWPhcjQvgOQoKQgXgooCUbUkWFDkMAH+EF/0g1dnXf289LjlvQsKhY7Y135Zpvm21kjUcj5mrLDlHJALzCVb8K/r/LCxjV5GFUyJiiNLAxkI9V1vZ4pMQvKIsN7wzu6gXK87w6mEWvKvipMAP8A2choDrk6H/fcQtfNodgwIDADAB;"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"records"</span>: <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">"ERROR"</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">"none"</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">"metadata"</span>: <button class="collapser" aria-label="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">"validate_current_dkims"</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/Mail-DNS-Settings/operation/validate_current_spfs" data-section-id="tag/Mail-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/Mail-DNS-Settings/operation/validate_current_spfs" aria-label="tag/Mail-DNS-Settings/operation/validate_current_spfs"></a>Validate domain SPF records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function validates a Sender Policy Framework (SPF) record for one or more domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function validates a Sender Policy Framework (SPF) 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><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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=example3.com</span> -<!-- --> <!-- -->Check multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.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 domain for which to check the SPF records.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to check the SPF 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99n59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99n59q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99n59q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n59q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99n59q:0" aria-labelledby="tab:R99n59q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99n59q:1" aria-labelledby="tab:R99n59q: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:R9pn59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pn59q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pn59q:0" aria-labelledby="tab:R9pn59q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"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 ~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 is not authorized by default to use 'example.com' in 'helo' identity (mechanism '-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">"FAIL"</span></div></li></ul><span class="token punctuation">}</span></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><li><div class="hoverable "><button class="collapser" aria-label="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">"error"</span>: <span class="token string">"(XID rm8h9f) DNS returned “SERVFAIL” (code 2) in response to the system’s query for “example2.com”’s “TXT” records."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_address"</span>: <span class="token string">"198.252.32.45"</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">"records"</span>: <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">"ERROR"</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">"metadata"</span>: <button class="collapser" aria-label="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">"validate_current_spfs"</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/Mail-DNS-Settings/operation/validate_current_ptrs" data-section-id="tag/Mail-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/Mail-DNS-Settings/operation/validate_current_ptrs" aria-label="tag/Mail-DNS-Settings/operation/validate_current_ptrs"></a>Validate domain PTR records<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function validates the pointer records (PTR) for IPv4 and IPv6 addresses an 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 (IPv4) or AAAA (IPv6) 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 an 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 (IPv4) or AAAA (IPv6) 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></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=example3.com</span> -<!-- --> <!-- -->Validate multiple domains' PTR records.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com&domain=example2.com&domain=example3.com</span> -<!-- --> <!-- -->Validate multiple domains' PTR records.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> -<!-- --> <!-- -->Validate a single domain's PTR records.</li></ul><div><div html="<p>The domain for which to validate the PTR records.</p>
<p><strong>Note:</strong></p>
<p>To check multiple domains, duplicate or increment the parameter name.
For example, use the <code>domain-1</code>, <code>domain-2</code>, and <code>domain-3</code> parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to validate the PTR records.</p>
<p><strong>Note:</strong></p>
<p>To check multiple domains, duplicate or increment the parameter name.
For example, use the <code>domain-1</code>, <code>domain-2</code>, and <code>domain-3</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99p59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99p59q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99p59q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99p59q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99p59q:0" aria-labelledby="tab:R99p59q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99p59q:1" aria-labelledby="tab:R99p59q: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:R9pp59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pp59q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pp59q:0" aria-labelledby="tab:R9pp59q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"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><li><div class="hoverable "><span class="token string">"ns2.example.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"ns3.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><li><div class="hoverable "><button class="collapser" aria-label="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">"3.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">"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.3"</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><li><div class="hoverable "><span class="token string">"ns2.example.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"ns3.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">"192.168.12.34"</span></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">"FWD_MISMATCH"</span></div></li></ul><span class="token punctuation">}</span></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">"PTR_MISMATCH"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"4.3.3.7.0.7.3.0.e.2.a.8.0.0.0.0.0.0.0.0.3.a.5.8.8.b.d.0.1.0.0.2.ip6.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">"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">"2001:0db8:85a3:0000:0000:8a2e:0370:7334"</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">"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><li><div class="hoverable "><span class="token string">"ns3.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">"2001:0db8:85a3:0000:0000:8a2e:0370:7334"</span></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><li><div class="hoverable "><button class="collapser" aria-label="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">"2.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">"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.2"</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><li><div class="hoverable "><span class="token string">"ns2.example.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"ns3.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>: <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">"MISSING_PTR"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"thisotheremaildomain.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">"thisothermaildomain.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">"1.1.1.1.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ptr_records"</span>: <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">"ERROR"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"4.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">"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.4"</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><li><div class="hoverable "><span class="token string">"ns2.example.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"ns3.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>: <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">"MISSING_FWD"</span></div></li></ul><span class="token punctuation">}</span></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">"PTR_MISMATCH"</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">"metadata"</span>: <button class="collapser" aria-label="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">"validate_current_ptrs"</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/Mail-DNS-Settings/operation/set_manual_mx_redirects" data-section-id="tag/Mail-DNS-Settings/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/Mail-DNS-Settings/operation/set_manual_mx_redirects" aria-label="tag/Mail-DNS-Settings/operation/set_manual_mx_redirects"></a>Add manual mail exchanger redirect record<!-- --> </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 /etc/manualmx file.</p>
<p><strong>Note:</strong></p>
<p> To remove a domain&#39;s manual MX redirection, use the WHM API 1 unset_manual_mx_redirect 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 /etc/manualmx file.</p>
<p><strong>Note:</strong></p>
<p> To remove a domain's manual MX redirection, use the WHM API 1 unset_manual_mx_redirect function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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 which to add a manual MX redirect entry.</p>
<p><strong>Note:</strong></p>
<p> To add multiple domain entries, increment the parameter. For example, use the domain, domain-1, and domain-2 parameters. For multiple domains, you must include its corresponding mx_host value.</p>
" 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>
<p> To add multiple domain entries, increment the parameter. For example, use the domain, domain-1, and domain-2 parameters. For multiple domains, you must include its corresponding mx_host value.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="mx_host" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mx_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">mx_host=mailhostexample.com</span></div><div><div html="<p>The domain or IP address (IPv4 or IPv6) to redirect the domain value&#39;s emails to.</p>
<p><strong>Note:</strong></p>
<p> To add multiple MX hosts, increment the parameter. For example, use the mx_host, mx_host-1, and mx_host-2 parameters. For multiple MX hosts, you must include its corresponding domain value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain or IP address (IPv4 or IPv6) to redirect the domain value's emails to.</p>
<p><strong>Note:</strong></p>
<p> To add multiple MX hosts, increment the parameter. For example, use the mx_host, mx_host-1, and mx_host-2 parameters. For multiple MX hosts, you must include its corresponding domain 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99r59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99r59q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99r59q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99r59q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99r59q:0" aria-labelledby="tab:R99r59q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_manual_mx_redirects <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">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:R99r59q:1" aria-labelledby="tab:R99r59q: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:R9pr59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pr59q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pr59q:0" aria-labelledby="tab:R9pr59q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"example.com"</span>: <span class="token string">"mailhostexample.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"example.org"</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">"metadata"</span>: <button class="collapser" aria-label="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">"set_manual_mx_redirects"</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/Mail-DNS-Settings/operation/unset_manual_mx_redirects" data-section-id="tag/Mail-DNS-Settings/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/Mail-DNS-Settings/operation/unset_manual_mx_redirects" aria-label="tag/Mail-DNS-Settings/operation/unset_manual_mx_redirects"></a>Remove manual mail exchanger redirect record<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes a domain&#39;s manual Exim mail exchanger (MX) redirect entry. The function also removes the manual MX redirect entry from the /etc/manualmx file.</p>
<p><strong>Note:</strong></p>
<p> To set a domain&#39;s manual MX redirection, use the WHM API 1 set_manual_mx_redirects function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a domain's manual Exim mail exchanger (MX) redirect entry. The function also removes the manual MX redirect entry from the /etc/manualmx file.</p>
<p><strong>Note:</strong></p>
<p> To set a domain's manual MX redirection, use the WHM API 1 set_manual_mx_redirects function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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 for which to remove a manual MX redirect entry.</p>
<p><strong>Note:</strong></p>
<p> To remove multiple domain entries, increment the parameter. For example, use the domain, domain-1, and domain-2 parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to remove a manual MX redirect entry.</p>
<p><strong>Note:</strong></p>
<p> To remove multiple domain entries, increment the parameter. For example, use the domain, domain-1, and domain-2 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99t59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99t59q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99t59q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99t59q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99t59q:0" aria-labelledby="tab:R99t59q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
unset_manual_mx_redirects <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:R99t59q:1" aria-labelledby="tab:R99t59q: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:R9pt59q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pt59q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pt59q:0" aria-labelledby="tab:R9pt59q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"example.com"</span>: <span class="token string">"mailhostexample.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"example.org"</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">"metadata"</span>: <button class="collapser" aria-label="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">"unset_manual_mx_redirects"</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/Mail-Server-Settings" data-section-id="tag/Mail-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/Mail-Server-Settings" aria-label="tag/Mail-Server-Settings"></a>Mail Server Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Mail / Mail Server Settings</p>
"><p>Mail / Mail Server Settings</p>
</div></div></div><div id="tag/Mail-Server-Settings/operation/generate_mobileconfig" data-section-id="tag/Mail-Server-Settings/operation/generate_mobileconfig" class="sc-dntaoT ceciOs"><div data-section-id="operation/generate_mobileconfig" id="operation/generate_mobileconfig" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mail-Server-Settings/operation/generate_mobileconfig" aria-label="tag/Mail-Server-Settings/operation/generate_mobileconfig"></a>Create email account mobile profile configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function generates a mobile configuration profile 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 generates a mobile configuration profile 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="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=username</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><tr class=""><td kind="field" title="selected_account_services" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">selected_account_services</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"email,caldav,carddav"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"caldav"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"carddav"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"email"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">selected_account_services=email</span></div><div><div html="<p>A comma-separated list of the email account service&#39;s <code>.mobileconfig</code> file names.</p>
<ul>
<li><code>caldav</code> — The <code>.mobileconfig</code> file for calendar setup.</li>
<li><code>carddav</code> — The <code>.mobileconfig</code> file for contacts setup.</li>
<li><code>email</code> — The <code>.mobileconfig</code> file for email setup.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>If you don&#39;t specify a value, this parameter uses the default values.</li>
<li>You can request one, two, or all possible values.</li>
<li>The function ignores unsupported values.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of the email account service's <code>.mobileconfig</code> file names.</p>
<ul>
<li><code>caldav</code> — The <code>.mobileconfig</code> file for calendar setup.</li>
<li><code>carddav</code> — The <code>.mobileconfig</code> file for contacts setup.</li>
<li><code>email</code> — The <code>.mobileconfig</code> file for email setup.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>If you don't specify a value, this parameter uses the default values.</li>
<li>You can request one, two, or all possible values.</li>
<li>The function ignores unsupported values.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="use_ssl" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">use_ssl</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">use_ssl=1</span></div><div><div html="<p>Whether to use an SSL-encrypted connection.</p>
<ul>
<li><code>1</code> — Use an SSL-encrypted connnection.</li>
<li><code>0</code> — Do <strong>not</strong> use an SSL-encrypted connection.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use an SSL-encrypted connection.</p>
<ul>
<li><code>1</code> — Use an SSL-encrypted connnection.</li>
<li><code>0</code> — Do <strong>not</strong> use an SSL-encrypted connection.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/generate_mobileconfig</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/generate_mobileconfig</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99379q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99379q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99379q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99379q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99379q:0" aria-labelledby="tab:R99379q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
generate_mobileconfig <span class="token punctuation">\</span>
<span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">use_ssl</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:R99379q:1" aria-labelledby="tab:R99379q: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:R9p379q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p379q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p379q:0" aria-labelledby="tab:R9p379q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"payload"</span>: <span class="token string">"MIIcIwYJKoZIhvcNAQcCoIIcFDCCHBACAQExDzANBglghkgBZQMEAgEFADCCFS4GCSqGSIb3DQEH\nAaCCFR8EghUbPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjwhRE9DVFlQ\nRSBwbGlzdCBQVUJMSUMgIi0vL0FwcGxlLy9EVEQgUExJU1QgMS4wLy9FTiIgImh0dHA6Ly93d3cu\nYXBwbGUuY29tL0RURHMvUHJvcGVydHlMaXN0LTEuMC5kdGQiPg0KPHBsaXN0IHZlcnNpb249IjEu\nMCI+DQo8ZGljdD4NCiAgPGtleT5QYXlsb2FkQ29udGVudDwva2V5Pg0KICA8YXJyYXk+DQogICAg\nPGRpY3Q+DQogICAgICAgIDxrZXk+Q2FsREFWQWNjb3VudERlc2NyaXB0aW9uPC9rZXk+DQogICAg\nICAgIDxzdHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDwvc3Ry\naW5nPg0KICAgICAgICA8a2V5PkNhbERBVkhvc3ROYW1lPC9rZXk+DQogICAgICAgIDxzdHJpbmc+\naG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDwvc3RyaW5nPg0KICAgICAgICA8a2V5PkNh\nbERBVlBvcnQ8L2tleT4NCiAgICAgICAgPGludGVnZXI+ODQ0MzwvaW50ZWdlcj4NCiAgICAgICAg\nPGtleT5DYWxEQVZQcmluY2lwYWxVUkw8L2tleT4NCiAgICAgICAgPHN0cmluZz4vcHJpbmNpcGFs\ncy9fX3VpZHNfXy8vPC9zdHJpbmc+DQogICAgICAgIDxrZXk+Q2FsREFWVXNlU1NMPC9rZXk+DQog\nICAgICAgIDx0cnVlLz4NCiAgICAgICAgPGtleT5DYWxEQVZVc2VybmFtZTwva2V5Pg0KICAgICAg\nICA8c3RyaW5nPnVzZXJuYW1lPC9zdHJpbmc+DQogICAgICAgIDxrZXk+UGF5bG9hZERlc2NyaXB0\naW9uPC9rZXk+DQogICAgICAgIDxzdHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYtMS0xMS5hc2hs\nZXk4MnNiLnRsZCBTZWN1cmUgQ2FsZW5kYXIgU2V0dXA8L3N0cmluZz4NCiAgICAgICAgPGtleT5Q\nYXlsb2FkRGlzcGxheU5hbWU8L2tleT4NCiAgICAgICAgPHN0cmluZz51c2VybmFtZUBob3N0LTE3\nMi0xNi0xLTExLmFzaGxleTgyc2IudGxkIFNlY3VyZSBDYWxlbmRhciBTZXR1cDwvc3RyaW5nPg0K\nICAgICAgICA8a2V5PlBheWxvYWRJZGVudGlmaWVyPC9rZXk+DQogICAgICAgIDxzdHJpbmc+Y3Bh\nbmVsLm1haWwub3JnLnVzZXJuYW1lLmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQ8L3N0\ncmluZz4NCiAgICAgICAgPGtleT5QYXlsb2FkT3JnYW5pemF0aW9uPC9rZXk+DQogICAgICAgIDxz\ndHJpbmc+aG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDwvc3RyaW5nPg0KICAgICAgICA8\na2V5PlBheWxvYWRUeXBlPC9rZXk+DQogICAgICAgIDxzdHJpbmc+Y29tLmFwcGxlLmNhbGRhdi5h\nY2NvdW50PC9zdHJpbmc+DQogICAgICAgIDxrZXk+UGF5bG9hZFVVSUQ8L2tleT4NCiAgICAgICAg\nPHN0cmluZz4wNWQ3OTBjMS03MjVlLTIxODUtMDM1YS0yODNiZGJkMDUxMWQ8L3N0cmluZz4NCiAg\nICAgICAgPGtleT5QYXlsb2FkVmVyc2lvbjwva2V5Pg0KICAgICAgICA8aW50ZWdlcj4xPC9pbnRl\nZ2VyPg0KICAgIDwvZGljdD4NCiAgICA8ZGljdD4NCiAgICAgICAgPGtleT5DYXJkREFWQWNjb3Vu\ndERlc2NyaXB0aW9uPC9rZXk+DQogICAgICAgIDxzdHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYt\nMS0xMS5hc2hsZXk4MnNiLnRsZCBTZWN1cmUgQ29udGFjdHMgU2V0dXA8L3N0cmluZz4NCiAgICAg\nICAgPGtleT5DYXJkREFWSG9zdE5hbWU8L2tleT4NCiAgICAgICAgPHN0cmluZz5ob3N0LTE3Mi0x\nNi0xLTExLmFzaGxleTgyc2IudGxkOjg0NDM8L3N0cmluZz4NCiAgICAgICAgPGtleT5DYXJkREFW\nVXNlU1NMPC9rZXk+DQogICAgICAgIDx0cnVlLz4NCiAgICAgICAgPGtleT5DYXJkREFWVXNlcm5h\nbWU8L2tleT4NCiAgICAgICAgPHN0cmluZz51c2VybmFtZTwvc3RyaW5nPg0KICAgICAgICA8a2V5\nPlBheWxvYWREZXNjcmlwdGlvbjwva2V5Pg0KICAgICAgICA8c3RyaW5nPnVzZXJuYW1lQGhvc3Qt\nMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQgU2VjdXJlIENvbnRhY3RzIFNldHVwPC9zdHJpbmc+\nDQogICAgICAgIDxrZXk+UGF5bG9hZERpc3BsYXlOYW1lPC9rZXk+DQogICAgICAgIDxzdHJpbmc+\nQ2FyZERBVjwvc3RyaW5nPg0KICAgICAgICA8a2V5PlBheWxvYWRJZGVudGlmaWVyPC9rZXk+DQog\nICAgICAgIDxzdHJpbmc+Y3BhbmVsLm1haWwub3JnLnVzZXJuYW1lLmhvc3QtMTcyLTE2LTEtMTEu\nYXNobGV5ODJzYi50bGQ8L3N0cmluZz4NCiAgICAgICAgPGtleT5QYXlsb2FkT3JnYW5pemF0aW9u\nPC9rZXk+DQogICAgICAgIDxzdHJpbmc+aG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDwv\nc3RyaW5nPg0KICAgICAgICA8a2V5PlBheWxvYWRUeXBlPC9rZXk+DQogICAgICAgIDxzdHJpbmc+\nY29tLmFwcGxlLmNhcmRkYXYuYWNjb3VudDwvc3RyaW5nPg0KICAgICAgICA8a2V5PlBheWxvYWRV\nVUlEPC9rZXk+DQogICAgICAgIDxzdHJpbmc+Y2U0YTRiYjEtODQ3Yi1hYWQ0LWVkMTUtNzIyMDY2\nMzA5YzIyPC9zdHJpbmc+DQogICAgICAgIDxrZXk+UGF5bG9hZFZlcnNpb248L2tleT4NCiAgICAg\nICAgPGludGVnZXI+MTwvaW50ZWdlcj4NCiAgICA8L2RpY3Q+DQogICAgPGRpY3Q+DQogICAgICA8\na2V5PkVtYWlsQWNjb3VudERlc2NyaXB0aW9uPC9rZXk+DQogICAgICA8c3RyaW5nPnVzZXJuYW1l\nQGhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQ8L3N0cmluZz4NCiAgICAgIDxrZXk+RW1h\naWxBY2NvdW50TmFtZTwva2V5Pg0KICAgICAgPHN0cmluZz51c2VybmFtZUBob3N0LTE3Mi0xNi0x\nLTExLmFzaGxleTgyc2IudGxkPC9zdHJpbmc+DQogICAgICA8a2V5PkVtYWlsQWNjb3VudFR5cGU8\nL2tleT4NCiAgICAgIDxzdHJpbmc+RW1haWxUeXBlSU1BUDwvc3RyaW5nPg0KICAgICAgPGtleT5F\nbWFpbEFkZHJlc3M8L2tleT4NCiAgICAgIDxzdHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYtMS0x\nMS5hc2hsZXk4MnNiLnRsZDwvc3RyaW5nPg0KICAgICAgPGtleT5JbmNvbWluZ01haWxTZXJ2ZXJB\ndXRoZW50aWNhdGlvbjwva2V5Pg0KICAgICAgPHN0cmluZz5FbWFpbEF1dGhQYXNzd29yZDwvc3Ry\naW5nPg0KICAgICAgPGtleT5JbmNvbWluZ01haWxTZXJ2ZXJIb3N0TmFtZTwva2V5Pg0KICAgICAg\nPHN0cmluZz5ob3N0LTE3Mi0xNi0xLTExLmFzaGxleTgyc2IudGxkPC9zdHJpbmc+DQogICAgICA8\na2V5PkluY29taW5nTWFpbFNlcnZlclBvcnROdW1iZXI8L2tleT4NCiAgICAgIDxpbnRlZ2VyPjk5\nMzwvaW50ZWdlcj4NCiAgICAgIDxrZXk+SW5jb21pbmdNYWlsU2VydmVyVXNlU1NMPC9rZXk+DQog\nICAgICA8dHJ1ZS8+DQogICAgICA8a2V5PkluY29taW5nTWFpbFNlcnZlclVzZXJuYW1lPC9rZXk+\nDQogICAgICA8c3RyaW5nPnVzZXJuYW1lPC9zdHJpbmc+DQogICAgICA8a2V5Pk91dGdvaW5nTWFp\nbFNlcnZlckF1dGhlbnRpY2F0aW9uPC9rZXk+DQogICAgICA8c3RyaW5nPkVtYWlsQXV0aFBhc3N3\nb3JkPC9zdHJpbmc+DQogICAgICA8a2V5Pk91dGdvaW5nTWFpbFNlcnZlckhvc3ROYW1lPC9rZXk+\nDQogICAgICA8c3RyaW5nPmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQ8L3N0cmluZz4N\nCiAgICAgIDxrZXk+T3V0Z29pbmdNYWlsU2VydmVyUG9ydE51bWJlcjwva2V5Pg0KICAgICAgPGlu\ndGVnZXI+NDY1PC9pbnRlZ2VyPg0KICAgICAgPGtleT5PdXRnb2luZ01haWxTZXJ2ZXJVc2VTU0w8\nL2tleT4NCiAgICAgIDx0cnVlLz4NCiAgICAgIDxrZXk+T3V0Z29pbmdNYWlsU2VydmVyVXNlcm5h\nbWU8L2tleT4NCiAgICAgIDxzdHJpbmc+dXNlcm5hbWU8L3N0cmluZz4NCiAgICAgIDxrZXk+T3V0\nZ29pbmdQYXNzd29yZFNhbWVBc0luY29taW5nUGFzc3dvcmQ8L2tleT4NCiAgICAgIDx0cnVlLz4N\nCiAgICAgIDxrZXk+UGF5bG9hZERlc2NyaXB0aW9uPC9rZXk+DQogICAgICA8c3RyaW5nPnVzZXJu\nYW1lQGhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQgU2VjdXJlIEVtYWlsIFNldHVwPC9z\ndHJpbmc+DQogICAgICA8a2V5PlBheWxvYWREaXNwbGF5TmFtZTwva2V5Pg0KICAgICAgPHN0cmlu\nZz51c2VybmFtZUBob3N0LTE3Mi0xNi0xLTExLmFzaGxleTgyc2IudGxkIFNlY3VyZSBFbWFpbCBT\nZXR1cDwvc3RyaW5nPg0KICAgICAgPGtleT5QYXlsb2FkSWRlbnRpZmllcjwva2V5Pg0KICAgICAg\nPHN0cmluZz5jcGFuZWwubWFpbC5vcmcudXNlcm5hbWUuaG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4\nMnNiLnRsZDwvc3RyaW5nPg0KICAgICAgPGtleT5QYXlsb2FkT3JnYW5pemF0aW9uPC9rZXk+DQog\nICAgICA8c3RyaW5nPmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQ8L3N0cmluZz4NCiAg\nICAgIDxrZXk+UGF5bG9hZFR5cGU8L2tleT4NCiAgICAgIDxzdHJpbmc+Y29tLmFwcGxlLm1haWwu\nbWFuYWdlZDwvc3RyaW5nPg0KICAgICAgPGtleT5QYXlsb2FkVVVJRDwva2V5Pg0KICAgICAgPHN0\ncmluZz5hNmIzZTAxMC0wMGMxLWIyZjAtYWU4Mi03ZmIzZjllODkzM2Y8L3N0cmluZz4NCiAgICAg\nIDxrZXk+UGF5bG9hZFZlcnNpb248L2tleT4NCiAgICAgIDxpbnRlZ2VyPjE8L2ludGVnZXI+DQog\nICAgICA8a2V5PlByZXZlbnRBcHBTaGVldDwva2V5Pg0KICAgICAgPGZhbHNlLz4NCiAgICAgIDxr\nZXk+UHJldmVudE1vdmU8L2tleT4NCiAgICAgIDxmYWxzZS8+DQogICAgICA8a2V5PlNNSU1FRW5h\nYmxlZDwva2V5Pg0KICAgICAgPGZhbHNlLz4NCiAgICAgIDxrZXk+SW5jb21pbmdNYWlsU2VydmVy\nSU1BUFBhdGhQcmVmaXg8L2tleT4NCiAgICAgIDxzdHJpbmc+SU5CT1g8L3N0cmluZz4NCiAgICA8\nL2RpY3Q+DQogIDwvYXJyYXk+DQogIDxrZXk+UGF5bG9hZERlc2NyaXB0aW9uPC9rZXk+DQogIDxz\ndHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZCBTZWN1cmUgRW1h\naWwgU2V0dXA8L3N0cmluZz4NCiAgPGtleT5QYXlsb2FkRGlzcGxheU5hbWU8L2tleT4NCiAgPHN0\ncmluZz51c2VybmFtZUBob3N0LTE3Mi0xNi0xLTExLmFzaGxleTgyc2IudGxkIFNlY3VyZSBFbWFp\nbCBTZXR1cDwvc3RyaW5nPg0KICA8a2V5PlBheWxvYWRJZGVudGlmaWVyPC9rZXk+DQogIDxzdHJp\nbmc+Y3BhbmVsLm1haWwub3JnLnVzZXJuYW1lLmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50\nbGQtZW1haWw8L3N0cmluZz4NCiAgPGtleT5QYXlsb2FkT3JnYW5pemF0aW9uPC9rZXk+DQogIDxz\ndHJpbmc+Y3BhbmVsLm1haWwub3JnLnVzZXJuYW1lLmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJz\nYi50bGQ8L3N0cmluZz4NCiAgPGtleT5QYXlsb2FkUmVtb3ZhbERpc2FsbG93ZWQ8L2tleT4NCiAg\nPGZhbHNlLz4NCiAgPGtleT5QYXlsb2FkVHlwZTwva2V5Pg0KICA8c3RyaW5nPkNvbmZpZ3VyYXRp\nb248L3N0cmluZz4NCiAgPGtleT5QYXlsb2FkVVVJRDwva2V5Pg0KICA8c3RyaW5nPjRmMzI4YTVm\nLWIzMzctODZmZS03Zjk4LTVhOWMyNzFlNzY0MTwvc3RyaW5nPg0KICA8a2V5PlBheWxvYWRWZXJz\naW9uPC9rZXk+DQogIDxpbnRlZ2VyPjE8L2ludGVnZXI+DQo8L2RpY3Q+DQo8L3BsaXN0Pg0KoIIE\nSTCCBEUwggMtoAMCAQICBQG7jhEyMA0GCSqGSIb3DQEBCwUAMF4xMjAwBgkqhkiG9w0BCQEWI3Nz\nbEBob3N0LTE3Mi0xNi0xLTExLmFzaGxleTgyc2IudGxkMSgwJgYDVQQDDB9ob3N0LTE3Mi0xNi0x\nLTExLmFzaGxleTgyc2IudGxkMB4XDTE5MTExOTEzMDk1OFoXDTIwMTExODEzMDk1OFowXjEyMDAG\nCSqGSIb3DQEJARYjc3NsQGhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQxKDAmBgNVBAMM\nH2hvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQDLTf43fqQJu57fAyGSBD+B/Zc3zVri44KCz/Oi9NlHCtmxET12+mE0TFkWGhjX+tzO\nfom+6Hj5KnGwr8K7qZoXq8zmiKGGvhvg11Ta6I3SJQL7VzU+wTBPXkAl+bWLBqoswzefA7A7jBZE\nv0c8W+wUAosjvmotUtiyeRsNbThTVBht7LwmHyCaAvHfIFkXkS96O6qqx0iZRlXZvahDjw6kiKOB\ne/kDpwl0YxMc3dEx2WCQyIZimtYOxNxglKKZ7UAnuKdy2we3AfOzhq3yKyDXsNyNrQghEn1aB1Ny\nY+/bYZYA/Mhlhk1jjMowEGsjLfJr1Kx6JhtBWzBPfUIkb4q7AgMBAAGjggEIMIIBBDAdBgNVHQ4E\nFgQUlzHaKABlXF/4KWQ7ZrNQij5iE/4wCQYDVR0TBAIwADCBjAYDVR0jBIGEMIGBgBSXMdooAGVc\nX/gpZDtms1CKPmIT/qFipGAwXjEyMDAGCSqGSIb3DQEJARYjc3NsQGhvc3QtMTcyLTE2LTEtMTEu\nYXNobGV5ODJzYi50bGQxKDAmBgNVBAMMH2hvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGSC\nBQG7jhEyMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAqBgNVHREEIzAhgh9ob3N0LTE3\nMi0xNi0xLTExLmFzaGxleTgyc2IudGxkMA0GCSqGSIb3DQEBCwUAA4IBAQCft6fX2NB0Lg3IM7UU\nw7eltKjsZOX3sCX/UQpwYdB8PcafoQ2Ddpb7H+CeyxW5tPk+qLpapnUWoIJBRahAQ+Xn3YWrJDfC\nFriWIdJH0Rk2Gwhydf7XM+yVm2HYBsAzfZWkF5EAjBJpgLN/28kAWdCv1p362nq79A/jrdKgpZdj\nz6fVb4aNMepJCcwIHivy7HN/PwmbXjqedwAMYsj/XEqw7aJX7+hI3VjFwkQxEbpyObVhcBhh+itt\n1O7t/MMWzg7mmJBnyTt+IbblYYEQoWvZXJgSGWT4U55mWF5arpjL9+NjFsbzvXl6TLEMzbVbpvxH\ntidgoiEpyBgzKFJ9p8TNMYICeTCCAnUCAQEwZzBeMTIwMAYJKoZIhvcNAQkBFiNzc2xAaG9zdC0x\nNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDEoMCYGA1UEAwwfaG9zdC0xNzItMTYtMS0xMS5hc2hs\nZXk4MnNiLnRsZAIFAbuOETIwDQYJYIZIAWUDBAIBBQCggeQwGAYJKoZIhvcNAQkDMQsGCSqGSIb3\nDQEHATAcBgkqhkiG9w0BCQUxDxcNMjAwODE0MjAwMjAwWjAvBgkqhkiG9w0BCQQxIgQguoXcvM7S\nh+TCpzAkazdEcoVI9NI91whPFvfJHZd9x4oweQYJKoZIhvcNAQkPMWwwajALBglghkgBZQMEASow\nCwYJYIZIAWUDBAEWMAsGCWCGSAFlAwQBAjAKBggqhkiG9w0DBzAOBggqhkiG9w0DAgICAIAwDQYI\nKoZIhvcNAwICAUAwBwYFKw4DAgcwDQYIKoZIhvcNAwICASgwDQYJKoZIhvcNAQEBBQAEggEACr8R\nPbw5CymW4Eep61SNsQzH54LXWbaS68mxF+Z8roOSLZTVYhBKP14bGJcUMhsS7c8zGYlOdwXWTA87\n4VQ0O4WIoWOsydxLVgHJ52ZDstN2iXsuW56Cm/Mk7Zow1MFdCJJ/ZX/oKOpnzm/t38kSvTXYyT/X\nLxGnTUYt+QbgUrqrxYZMbZeaAvGXkFTjTSi1kklZdnd7ndvashv5OhQ6zf6y831/c2M7mrn8vJKv\ne44Inb5NRBoK0MAc3f0vmAXrF087ayyNy6E1DqpdPWAGpCKYfIzWtIccrxKcguoIM4mWZ/Lp6mrZ\nI/2K6npCz9Wlm7iYASSsP3NMO8JWk7EWPA==\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">"metadata"</span>: <button class="collapser" aria-label="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">"generate_mobileconfig"</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/Mail-Server-Settings/operation/normalize_user_email_configuration" data-section-id="tag/Mail-Server-Settings/operation/normalize_user_email_configuration" class="sc-dntaoT ceciOs"><div data-section-id="operation/normalize_user_email_configuration" id="operation/normalize_user_email_configuration" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mail-Server-Settings/operation/normalize_user_email_configuration" aria-label="tag/Mail-Server-Settings/operation/normalize_user_email_configuration"></a>Repair misconfigured email settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function fixes a user&#39;s misconfigured email settings. This includes any misconfigured email file and directory ownership and permissions.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function fixes a user's misconfigured email settings. This includes any misconfigured email file and directory ownership and permissions.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><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 cPanel account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="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">/normalize_user_email_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/normalize_user_email_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:R99579q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99579q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99579q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99579q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99579q:0" aria-labelledby="tab:R99579q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
normalize_user_email_configuration <span class="token punctuation">\</span>
<span class="token assign-left variable">username</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:R99579q:1" aria-labelledby="tab:R99579q: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:R9p579q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p579q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p579q:0" aria-labelledby="tab:R9p579q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"normalize_user_email_configuration"</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/Mail-Server-Settings/operation/exim_configuration_check" data-section-id="tag/Mail-Server-Settings/operation/exim_configuration_check" class="sc-dntaoT ceciOs"><div data-section-id="operation/exim_configuration_check" id="operation/exim_configuration_check" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mail-Server-Settings/operation/exim_configuration_check" aria-label="tag/Mail-Server-Settings/operation/exim_configuration_check"></a>Repair Exim configuration file<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function scans the Exim configuration file for errors, and if it finds errors attempts to repair them.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function scans the Exim configuration file for errors, and if it finds errors attempts to repair 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/exim_configuration_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/exim_configuration_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:R99779q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99779q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99779q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99779q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99779q:0" aria-labelledby="tab:R99779q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
exim_configuration_check
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99779q:1" aria-labelledby="tab:R99779q: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:R9p779q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p779q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p779q:0" aria-labelledby="tab:R9p779q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"cPanel was unable to automatically merge your Exim configuration with the new settings that shipped\nwith the build you have installed (11.38.0 (build 9999)) because you have a custom or broken configuration which\ncannot be automatically configured.\n Since this configuration update is not critical, we left your previous configuration intact until\nthe new configuration can be properly installed. In order to complete this configuration update, you will \nneed to manually merge your configuration with the new configuration settings.\n\n\nPlease follow the steps below to complete this update:\n\n\t1. <a href='javascript:select_exim_backup();'>Backup your existing configuration</a>\n\t2. <a href='javascript:select_exim_advanced();'>Notate any custom changes you have made in the ACL section in the 'Advanced Editor Tab'.</a>\n\t3. <a href='javascript:select_exim_reset();'>Choose 'Reset cPanel & WHM Exim configuration files, one option at a time, until the installed Exim configuration is valid' under the 'Reset Tab'.</a>\n\t4. <a href='javascript:select_exim_advanced();'>Reinstall your customizations in the 'Advanced Editor Tab'.</a>\n\n\nCurrent Config Version: 10.320000\nNew Config Version: 10.330000"</span></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">"command"</span>: <span class="token string">"exim_configuration_check"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Configuration Update Failed"</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/Mail-Server-Settings/operation/fetch_mail_queue" data-section-id="tag/Mail-Server-Settings/operation/fetch_mail_queue" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_mail_queue" id="operation/fetch_mail_queue" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mail-Server-Settings/operation/fetch_mail_queue" aria-label="tag/Mail-Server-Settings/operation/fetch_mail_queue"></a>Return server mail queue contents<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the contents of the server&#39;s mail queue.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the contents of the server's mail 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/fetch_mail_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/fetch_mail_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:R99979q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99979q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99979q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99979q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99979q:0" aria-labelledby="tab:R99979q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
fetch_mail_queue
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99979q:1" aria-labelledby="tab:R99979q: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:R9p979q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p979q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p979q:0" aria-labelledby="tab:R9p979q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"frozen"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msgid"</span>: <span class="token string">"1UotX3-0002HX-Lr"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recipients"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"pricilla@graceland.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">"sender"</span>: <span class="token string">"elvis@graceland.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">14336</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"time"</span>: <span class="token number">1371552781</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token keyword">null</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">"metadata"</span>: <button class="collapser" aria-label="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">"fetch_mail_queue"</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/Mail-Server-Settings/operation/remove_in_progress_exim_config_edit" data-section-id="tag/Mail-Server-Settings/operation/remove_in_progress_exim_config_edit" class="sc-dntaoT ceciOs"><div data-section-id="operation/remove_in_progress_exim_config_edit" id="operation/remove_in_progress_exim_config_edit" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mail-Server-Settings/operation/remove_in_progress_exim_config_edit" aria-label="tag/Mail-Server-Settings/operation/remove_in_progress_exim_config_edit"></a>Remove Exim configuration files after failed update<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes in-progress Exim configuration files after
a failed update to Exim. When cPanel &amp; WHM attempts to update an Exim configuration,
the system creates dry run files to replace of the ordinary configuration
files.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If the update fails, the system leaves these dry run files in place.</li>
<li>When the user accesses the <em>Advanced Editor</em> section of WHM&#39;s <a href="https://docs.cpanel.net/whm/service-configuration/exim-configuration-manager/"><em>Exim Configuration Manager</em></a>
interface (<em>Home &gt;&gt; Service Configuration &gt;&gt; Exim Configuration Manager</em>),
they access these dry run files instead of the actual configuration files.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes in-progress Exim configuration files after
a failed update to Exim. When cPanel & WHM attempts to update an Exim configuration,
the system creates dry run files to replace of the ordinary configuration
files.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If the update fails, the system leaves these dry run files in place.</li>
<li>When the user accesses the <em>Advanced Editor</em> section of WHM's <a href="https://docs.cpanel.net/whm/service-configuration/exim-configuration-manager/"><em>Exim Configuration Manager</em></a>
interface (<em>Home >> Service Configuration >> Exim Configuration Manager</em>),
they access these dry run files instead of the actual configuration files.</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="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">/remove_in_progress_exim_config_edit</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remove_in_progress_exim_config_edit</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b79q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b79q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b79q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b79q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b79q:0" aria-labelledby="tab:R99b79q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remove_in_progress_exim_config_edit
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b79q:1" aria-labelledby="tab:R99b79q: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:R9pb79q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb79q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb79q:0" aria-labelledby="tab:R9pb79q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"remove_in_progress_exim_config_edit"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Removed 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/Mail-Server-Settings/operation/validate_current_installed_exim_config" data-section-id="tag/Mail-Server-Settings/operation/validate_current_installed_exim_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/validate_current_installed_exim_config" id="operation/validate_current_installed_exim_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mail-Server-Settings/operation/validate_current_installed_exim_config" aria-label="tag/Mail-Server-Settings/operation/validate_current_installed_exim_config"></a>Validate Exim configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function validates the system&#39;s current Exim configuration.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function validates the system's current Exim 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/validate_current_installed_exim_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/validate_current_installed_exim_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:R99d79q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d79q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d79q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d79q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d79q:0" aria-labelledby="tab:R99d79q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
validate_current_installed_exim_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d79q:1" aria-labelledby="tab:R99d79q: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:R9pd79q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd79q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd79q:0" aria-labelledby="tab:R9pd79q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"<pre>Doing Dry Run\nDry Run ok\nEnabled system filter options: attachments| fail_spam_score_over_int|spam_rewrite\nEnabled ACL options in block ACL_MAIL_PRE_BLOCK: default_mail_pre\nEnabled ACL options in block ACL_RBL_BLOCK: primary_hostname_bl\n Enabled ACL options in block ACL_RECIPIENT_POST_BLOCK: default_recipient_post\nEnabled ACL options in block ACL_SPAM_SCAN_CHECK_BLOCK: default_spam_scan_check\nEnabled ACL options in block ACL_CHECK_MESSAGE_PRE_BLOCK: default_check_message_pre \nEnabled ACL options in block ACL_CONNECT_POST_BLOCK: default_connect_post \nEnabled ACL options in block ACL_CONNECT_BLOCK: ratelimit|spammerlist \nEnabled ACL options in block ACL_POST_RECP_VERIFY_BLOCK: dictionary_attack\nEnabled ACL options in block ACL_IDENTIFY_SENDER_BLOCK: default_identify_sender\nEnabled ACL options in block ACL_MAIL_BLOCK: requirehelo| requirehelonoforge|requirehelosyntax\nEnabled ACL options in block ACL_RATELIMIT_SPAM_BLOCK: ratelimit_spam_score_over_int\nEnabled ACL options in block ACL_CHECK_MESSAGE_POST_BLOCK: default_check_message_post\nEnabled ACL options in block ACL_POST_SPAM_SCAN_CHECK_BLOCK: mailproviders \nEnabled ACL options in block ACL_SPAM_SCAN_BLOCK: default_spam_scan \nEnabled ACL options in block ACL_RATELIMIT_BLOCK: 0tracksenders\nEnabled ACL options in block ACL_NOTQUIT_BLOCK: ratelimit\nEnabled ACL options in block ACL_RECP_VERIFY_BLOCK: default_recp_verify\nEnabled ACL options in block ACL_PRE_SPAM_SCAN: mailproviders\nEnabled ACL options in block ACL_SPAM_BLOCK: deny_spam_score_over_int\nEnabled ACL options in block ACL_EXISCAN_BLOCK: default_exiscan\nEnabled ACL options in block ACL_RECIPIENT_BLOCK: default_recipient\nEnabled ACL options in block ACL_MAIL_POST_BLOCK: default_mail_post\nThe system detected spam handling in acls and will now disable Apache SpamAssassin in routers and transports!\nThe Apache SpamAssassin method remains unchanged.\nConfigured options list is:\nACL: acl_smtp_connect is active\nACL: acl_smtp_data is active\nACL: acl_smtp_mail is active\nACL: acl_smtp_notquit is active\nACL: acl_smtp_rcpt is active\nProvided options list is: daemon_smtp_ports| tls_on_connect_ports|system_filter_user|system_filter_group|tls_require_ciphers|hostlist loopback|hostlist senderverifybypass_hosts|hostlist skipsmtpcheck_hosts|hostlist spammeripblocks|hostlist backupmx_hosts|hostlist trustedmailhosts|hostlist relay_hosts| domainlist user_domains|remote_max_parallel|smtp_receive_timeout| ignore_bounce_errors_after|rfc1413_query_timeout|timeout_frozen_after|auto_thaw| callout_domain_negative_expire|callout_negative_expire|acl_smtp_connect| acl_smtp_data|acl_smtp_mail|acl_smtp_notquit|acl_smtp_rcpt|perl_at_start| daemon_smtp_ports|tls_on_connect_ports|system_filter_user|system_filter_ group|tls_require_ciphers|spamd_address\nExim Insert Regex is: virtual_userdelivery| virtual_aliases|lookuphost|virtual_user|address_pipe|virtual_sa_user|localuser\nExim Replace Regex is: virtual_sa_user|sa_localuser|virtual_sa_userdelivery| local_sa_delivery|central_filter|central_user_filter|democheck|fail_remote_domains| fixed_login|fixed_plain|has_alias_but_no_mailbox_discarded_to_prevent_loop|literal| local_delivery|local_delivery_spam|localuser|localuser_spam|lookuphost|remote_smtp| secure_login|secure_plain|userforward|virtual_aliases|virtual_aliases_nostar| virtual_user|virtual_user_spam|virtual_userdelivery|virtual_userdelivery_spam\nExim Match Insert Regex is: quota_directory|maildir_format\nExim version 4.76 #1 built 16- Aug-2011 11:41:07\nCopyright (c) University of Cambridge, 1995 - 2007\nBerkeley DB: Sleepycat Software: Berkeley DB 4.3.29: (July 12, 2010)\nSupport for: crypteq iconv() IPv6 PAM Perl OpenSSL Content_Scanning DKIM Old_Demime Experimental_SPF Experimental_SRS\nLookups (built-in): lsearch wildlsearch nwildlsearch iplsearch dbm dbmnz passwd\nAuthenticators: cram_md5 dovecot plaintext spa\nRouters: accept dnslookup ipliteral manualroute queryprogram redirect\nTransports: appendfile/maildir autoreply pipe smtp\nSize of off_t: 8\n\n</pre>"</span></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">"command"</span>: <span class="token string">"validate_current_installed_exim_config"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Your configuration is currently valid."</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/Mail-Server-Settings/operation/validate_exim_configuration_syntax" data-section-id="tag/Mail-Server-Settings/operation/validate_exim_configuration_syntax" class="sc-dntaoT ceciOs"><div data-section-id="operation/validate_exim_configuration_syntax" id="operation/validate_exim_configuration_syntax" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mail-Server-Settings/operation/validate_exim_configuration_syntax" aria-label="tag/Mail-Server-Settings/operation/validate_exim_configuration_syntax"></a>Validate Exim configure file syntax<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function evaluates and validates an Exim configuration file&#39;s syntax.</p>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of SPF resource
records on DNS.</p>
<ul>
<li>This warning is not relevant on CentOS 7 servers, because
<a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>.
CentOS 7 servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated version of
BIND that complies with RFC 7208. To resolve this issue, update your operating system to a
version that contains the updated version of BIND. For more information, read the
<a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function evaluates and validates an Exim configuration file's syntax.</p>
<p><strong>Note:</strong></p>
<p>On servers that run CentOS 7, you may see a <code>named</code> warning about the absence of SPF resource
records on DNS.</p>
<ul>
<li>This warning is not relevant on CentOS 7 servers, because
<a href="https://tools.ietf.org/html/rfc7208">RFC 7208 deprecated SPF records</a>.
CentOS 7 servers use TXT records instead of SPF records.</li>
<li>Red Hat 7.1 and CentOS 7.1 both contain <code>bind-9.9.4-23.el7</code>, which is an updated version of
BIND that complies with RFC 7208. To resolve this issue, update your operating system to a
version that contains the updated version of BIND. For more information, read the
<a href="https://bugzilla.redhat.com/show_bug.cgi?id=1215164">Red Hat Bugzilla case about SPF record errors</a>.</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="cfg_text" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cfg_text</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->HTML<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cfg_text=RAW_CONFIGURATION_TEXT</span></div><div><div html="<p>The Exim configuration file&#39;s raw text.</p>
<p><strong>Note:</strong></p>
<p>If you do not use this parameter, the function will analyze Exim&#39;s current configuration.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Exim configuration file's raw text.</p>
<p><strong>Note:</strong></p>
<p>If you do not use this parameter, the function will analyze Exim's current configuration.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="section" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">section</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">section=acl</span></div><div><div html="<p>The Exim configuration file&#39;s section to check.</p>
<p><strong>Note:</strong></p>
<p>If you use this parameter, pass <strong>only</strong> the desired section to validate as the
<code>cfg_text</code> value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Exim configuration file's section to check.</p>
<p><strong>Note:</strong></p>
<p>If you use this parameter, pass <strong>only</strong> the desired section to validate as the
<code>cfg_text</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object or object</span></div> <div><div html="<p>An object containing a valid or invalid Exim configuration information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An object containing a valid or invalid Exim configuration information.</p>
</div></div></div></td></tr><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">/validate_exim_configuration_syntax</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/validate_exim_configuration_syntax</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f79q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f79q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f79q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f79q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f79q:0" aria-labelledby="tab:R99f79q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
validate_exim_configuration_syntax
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f79q:1" aria-labelledby="tab:R99f79q: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:R9pf79q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf79q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf79q:0" aria-labelledby="tab:R9pf79q:0"><div><div class="sc-Rjrgp dIDLbO"><span 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="An invalid Exim configuration." selected="">An invalid Exim configuration.</option><option value="A valid Exim configuration.">A valid Exim configuration.</option></select><label>An invalid Exim configuration.</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">"command"</span>: <span class="token string">"validate_exim_configuration_syntax"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"broken_cfg_html"</span>: <span class="token string">"RAW_CONFIGURATION_TEXT"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"broken_cfg_text"</span>: <span class="token string">"==>RAW_CONFIGURATION_TEXT<==\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error_line"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error_msg"</span>: <span class="token string">"This is an error message."</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"raw"</span>: <span class="token string">"\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">"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></code></div></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mail-Server-Settings/operation/is_sni_supported" data-section-id="tag/Mail-Server-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/Mail-Server-Settings/operation/is_sni_supported" aria-label="tag/Mail-Server-Settings/operation/is_sni_supported"></a>Return server SNI support status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks whether the server supports SNI (Server Name Indication).</p>
<p><strong>Note:</strong></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 checks whether the server supports SNI (Server Name Indication).</p>
<p><strong>Note:</strong></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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99h79q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h79q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h79q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h79q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h79q:0" aria-labelledby="tab:R99h79q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
is_sni_supported
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h79q:1" aria-labelledby="tab:R99h79q: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:R9ph79q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph79q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph79q:0" aria-labelledby="tab:R9ph79q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"sni"</span>: <span class="token number">1</span></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">"command"</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">"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/Mail-Server-Settings/operation/mail_sni_status" data-section-id="tag/Mail-Server-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/Mail-Server-Settings/operation/mail_sni_status" aria-label="tag/Mail-Server-Settings/operation/mail_sni_status"></a>Return domain's SNI mail services status<!-- --> </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>Note:</strong></p>
<p>Functions that disable Mail SNI fail and make no changes.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the status of the domain's SNI mail services.</p>
<p><strong>Note:</strong></p>
<p>Functions that disable Mail SNI fail and make no changes.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99j79q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j79q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j79q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j79q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j79q:0" aria-labelledby="tab:R99j79q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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:R99j79q:1" aria-labelledby="tab:R99j79q: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:R9pj79q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj79q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj79q:0" aria-labelledby="tab:R9pj79q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"metadata"</span>: <button class="collapser" aria-label="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">"mail_sni_status"</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/Mail-Server-Settings/operation/rebuild_mail_sni_config" data-section-id="tag/Mail-Server-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/Mail-Server-Settings/operation/rebuild_mail_sni_config" aria-label="tag/Mail-Server-Settings/operation/rebuild_mail_sni_config"></a>Rebuild mail SNI configuration files<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function rebuilds the mail SNI configuration files.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function rebuilds the mail SNI configuration 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><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">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">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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R99l79q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99l79q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99l79q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l79q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99l79q:0" aria-labelledby="tab:R99l79q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
rebuild_mail_sni_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l79q:1" aria-labelledby="tab:R99l79q: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:R9pl79q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pl79q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pl79q:0" aria-labelledby="tab:R9pl79q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"configs_built"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"/etc/dovecot/sni.conf"</span></div></li></ul><span class="token punctuation">]</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">"metadata"</span>: <button class="collapser" aria-label="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">"rebuild_mail_sni_config"</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/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>Mail / Spam Management</p>
"><p>Mail / Spam Management</p>
</div></div></div><div id="tag/Spam-Management/operation/block_incoming_email_from_country" data-section-id="tag/Spam-Management/operation/block_incoming_email_from_country" class="sc-dntaoT ceciOs"><div data-section-id="operation/block_incoming_email_from_country" id="operation/block_incoming_email_from_country" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/block_incoming_email_from_country" aria-label="tag/Spam-Management/operation/block_incoming_email_from_country"></a>Add block on emails from specific countries<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function blocks email from specific countries.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function blocks email from specific countries.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="country_code" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">country_code</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-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">country_code=country_code-1=AA country_code-2=AB country_code-3=AC</span> -<!-- --> <!-- -->Multiple country codes.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">country_code=AA</span> -<!-- --> <!-- -->A single country code.</li></ul><div><div html="<p>The country to block.
The <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166-1 alpha-2 code</a> two-letter country code.</p>
<p><strong>Warning:</strong></p>
<p>Do <strong>not</strong> block the <code>ZZ</code> country code if the server uses a <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/1-1-nat/">NAT</a> configuration.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To search all available country codes, read the ISO&#39;s <a href="https://www.iso.org/obp/ui">Full list of Country Codes</a> documentation.</li>
<li>To block multiple countries, duplicate or increment the parameter name. For example: <code>country_code-1</code>, <code>country_code-2</code>, and <code>country_code-3</code>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The country to block.
The <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166-1 alpha-2 code</a> two-letter country code.</p>
<p><strong>Warning:</strong></p>
<p>Do <strong>not</strong> block the <code>ZZ</code> country code if the server uses a <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/1-1-nat/">NAT</a> configuration.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To search all available country codes, read the ISO's <a href="https://www.iso.org/obp/ui">Full list of Country Codes</a> documentation.</li>
<li>To block multiple countries, duplicate or increment the parameter name. For example: <code>country_code-1</code>, <code>country_code-2</code>, and <code>country_code-3</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/block_incoming_email_from_country</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/block_incoming_email_from_country</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj99q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj99q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj99q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj99q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj99q:0" aria-labelledby="tab:R4kj99q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
block_incoming_email_from_country <span class="token punctuation">\</span>
<span class="token assign-left variable">country_code</span><span class="token operator">=</span><span class="token string">'AA'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj99q:1" aria-labelledby="tab:R4kj99q: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:R4sj99q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj99q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj99q:0" aria-labelledby="tab:R4sj99q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"metadata"</span>: <button class="collapser" aria-label="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">"block_incoming_email_from_country"</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/Spam-Management/operation/block_incoming_email_from_domain" data-section-id="tag/Spam-Management/operation/block_incoming_email_from_domain" class="sc-dntaoT ceciOs"><div data-section-id="operation/block_incoming_email_from_domain" id="operation/block_incoming_email_from_domain" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/block_incoming_email_from_domain" aria-label="tag/Spam-Management/operation/block_incoming_email_from_domain"></a>Add block on emails from specific domains<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function blocks email from specific domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function blocks email from specific 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-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 block.</p>
<p><strong>Note:</strong></p>
<ul>
<li>The function returns <code>0</code> for the <code>updated</code> return if the server already blocks that domain.</li>
<li>An FQDN requires <strong>at least</strong> <a href="https://en.wikipedia.org/wiki/Domain_name#Domain_name_syntax">a label, a dot (<code>.</code>), and a top-level domain (TLD)</a>.</li>
<li>Enter an asterisk (<code>*</code>) to represent <a href="https://en.wikipedia.org/wiki/Wildcard_DNS_record">a wildcard label or TLD</a>.</li>
<li>To block multiple domains, duplicate or increment the parameter name.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain to block.</p>
<p><strong>Note:</strong></p>
<ul>
<li>The function returns <code>0</code> for the <code>updated</code> return if the server already blocks that domain.</li>
<li>An FQDN requires <strong>at least</strong> <a href="https://en.wikipedia.org/wiki/Domain_name#Domain_name_syntax">a label, a dot (<code>.</code>), and a top-level domain (TLD)</a>.</li>
<li>Enter an asterisk (<code>*</code>) to represent <a href="https://en.wikipedia.org/wiki/Wildcard_DNS_record">a wildcard label or TLD</a>.</li>
<li>To block multiple domains, duplicate or increment the parameter name.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/block_incoming_email_from_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/block_incoming_email_from_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:R4kl99q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl99q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl99q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl99q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl99q:0" aria-labelledby="tab:R4kl99q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
block_incoming_email_from_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:R4kl99q:1" aria-labelledby="tab:R4kl99q: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:R4sl99q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl99q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl99q:0" aria-labelledby="tab:R4sl99q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"metadata"</span>: <button class="collapser" aria-label="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">"block_incoming_email_from_domain"</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/Spam-Management/operation/list_blocked_incoming_email_countries" data-section-id="tag/Spam-Management/operation/list_blocked_incoming_email_countries" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_blocked_incoming_email_countries" id="operation/list_blocked_incoming_email_countries" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/list_blocked_incoming_email_countries" aria-label="tag/Spam-Management/operation/list_blocked_incoming_email_countries"></a>Return blocked email countries list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists which countries cannot send email to the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists which countries cannot send email to the 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_blocked_incoming_email_countries</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_blocked_incoming_email_countries</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn99q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn99q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn99q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn99q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn99q:0" aria-labelledby="tab:R4kn99q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_blocked_incoming_email_countries
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn99q:1" aria-labelledby="tab:R4kn99q: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:R4sn99q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn99q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn99q:0" aria-labelledby="tab:R4sn99q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"countries"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"country_code"</span>: <span class="token string">"AD"</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">"metadata"</span>: <button class="collapser" aria-label="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">"list_blocked_incoming_email_countries"</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/Spam-Management/operation/list_blocked_incoming_email_domains" data-section-id="tag/Spam-Management/operation/list_blocked_incoming_email_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_blocked_incoming_email_domains" id="operation/list_blocked_incoming_email_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/list_blocked_incoming_email_domains" aria-label="tag/Spam-Management/operation/list_blocked_incoming_email_domains"></a>Return blocked email domains list<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists which domains cannot send email to the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists which domains cannot send email to the 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_blocked_incoming_email_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_blocked_incoming_email_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:R4kp99q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp99q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp99q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp99q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp99q:0" aria-labelledby="tab:R4kp99q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_blocked_incoming_email_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp99q:1" aria-labelledby="tab:R4kp99q: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:R4sp99q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp99q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp99q:0" aria-labelledby="tab:R4sp99q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 "><button class="collapser" aria-label="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></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">"command"</span>: <span class="token string">"list_blocked_incoming_email_domains"</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/Spam-Management/operation/unblock_incoming_email_from_domain" data-section-id="tag/Spam-Management/operation/unblock_incoming_email_from_domain" class="sc-dntaoT ceciOs"><div data-section-id="operation/unblock_incoming_email_from_domain" id="operation/unblock_incoming_email_from_domain" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/unblock_incoming_email_from_domain" aria-label="tag/Spam-Management/operation/unblock_incoming_email_from_domain"></a>Remove block on emails from specific domains<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function unblocks email from specific domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function unblocks email from specific 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-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 unblock.</p>
<p><strong>Note:</strong></p>
<ul>
<li>The function returns <code>0</code> for the updated return if the server already doesn&#39;t block that domain.</li>
<li>An FQDN requires <strong>at least</strong> <a href="https://en.wikipedia.org/wiki/Domain_name#Domain_name_syntax">a label, a dot (<code>.</code>), and a top-level domain (TLD)</a>.</li>
<li>Enter an asterisk (<code>*</code>) to represent <a href="https://en.wikipedia.org/wiki/Wildcard_DNS_record">a wildcard label or TLD</a>.</li>
<li>To unblock multiple domains, duplicate or increment the parameter name.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain to unblock.</p>
<p><strong>Note:</strong></p>
<ul>
<li>The function returns <code>0</code> for the updated return if the server already doesn't block that domain.</li>
<li>An FQDN requires <strong>at least</strong> <a href="https://en.wikipedia.org/wiki/Domain_name#Domain_name_syntax">a label, a dot (<code>.</code>), and a top-level domain (TLD)</a>.</li>
<li>Enter an asterisk (<code>*</code>) to represent <a href="https://en.wikipedia.org/wiki/Wildcard_DNS_record">a wildcard label or TLD</a>.</li>
<li>To unblock multiple domains, duplicate or increment the parameter name.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/unblock_incoming_email_from_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/unblock_incoming_email_from_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:R4kr99q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr99q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr99q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr99q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr99q:0" aria-labelledby="tab:R4kr99q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
unblock_incoming_email_from_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:R4kr99q:1" aria-labelledby="tab:R4kr99q: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:R4sr99q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr99q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr99q:0" aria-labelledby="tab:R4sr99q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"metadata"</span>: <button class="collapser" aria-label="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">"unblock_incoming_email_from_domain"</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/Spam-Management/operation/unblock_incoming_email_from_country" data-section-id="tag/Spam-Management/operation/unblock_incoming_email_from_country" class="sc-dntaoT ceciOs"><div data-section-id="operation/unblock_incoming_email_from_country" id="operation/unblock_incoming_email_from_country" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/unblock_incoming_email_from_country" aria-label="tag/Spam-Management/operation/unblock_incoming_email_from_country"></a>Remove block on emails from specific countries<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function unblocks email from specific countries.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function unblocks email from specific countries.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="country_code" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">country_code</span></td><td class="sc-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">country_code=country_code=US&country_code=AD</span> -<!-- --> <!-- -->To unblock multiple country codes.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">country_code=country_code=US&country_code-1=AD&country_code-2=ES</span> -<!-- --> <!-- -->To unblock multiple country codes using index parameters.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">country_code=US</span> -<!-- --> <!-- -->To unblock one country code.</li></ul><div><div html="<p>The country to unblock. A valid <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166-1 alpha-2 code</a> two-letter country code.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To search all available country codes, read the ISO&#39;s <a href="https://www.iso.org/obp/ui">Full list of Country Codes</a> documentation.</li>
<li>To unblock multiple countries, duplicate or increment the parameter name. For example, to unblock three countries, you could:<ul>
<li>Use the <code>country_code</code> parameter multiple times.</li>
<li>Use the <code>country_code</code>, <code>country_code-1</code>, and <code>country_code-2</code> parameters.</li>
</ul>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The country to unblock. A valid <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166-1 alpha-2 code</a> two-letter country code.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To search all available country codes, read the ISO's <a href="https://www.iso.org/obp/ui">Full list of Country Codes</a> documentation.</li>
<li>To unblock multiple countries, duplicate or increment the parameter name. For example, to unblock three countries, you could:<ul>
<li>Use the <code>country_code</code> parameter multiple times.</li>
<li>Use the <code>country_code</code>, <code>country_code-1</code>, and <code>country_code-2</code> parameters.</li>
</ul>
</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/unblock_incoming_email_from_country</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/unblock_incoming_email_from_country</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kt99q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kt99q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kt99q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt99q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kt99q:0" aria-labelledby="tab:R4kt99q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
unblock_incoming_email_from_country
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt99q:1" aria-labelledby="tab:R4kt99q: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:R4st99q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4st99q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4st99q:0" aria-labelledby="tab:R4st99q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"metadata"</span>: <button class="collapser" aria-label="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">"unblock_incoming_email_from_country"</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/Spam-Management/operation/save_spamd_config" data-section-id="tag/Spam-Management/operation/save_spamd_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/save_spamd_config" id="operation/save_spamd_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/save_spamd_config" aria-label="tag/Spam-Management/operation/save_spamd_config"></a>Update Apache SpamAssassin™ configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function configures your Apache SpamAssassin™ options.</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">Spam Filter role</a>, the system disables this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function configures your Apache SpamAssassin™ options.</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">Spam Filter 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="allowedips" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">allowedips</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">allowedips=127.0.0.1,192.168.0.1</span></div><div><div html="<p>A comma-separated list of IP addresses to authorize to access the spamd daemon.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you do <strong>not</strong> specify a value, the <code>spamd</code> daemon allows connections from any IP address.</li>
<li>If you set a value for this parameter, it <strong>must</strong> include <code>127.0.0.1</code> in the list of values so that the <code>chkservd</code> daemon can access the <code>spamd</code> daemon.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of IP addresses to authorize to access the spamd daemon.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you do <strong>not</strong> specify a value, the <code>spamd</code> daemon allows connections from any IP address.</li>
<li>If you set a value for this parameter, it <strong>must</strong> include <code>127.0.0.1</code> in the list of values so that the <code>chkservd</code> daemon can access the <code>spamd</code> daemon.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxchildren" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">maxchildren</span></td><td class="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">maxchildren=5</span></div><div><div html="<p>The maximum number of children per <code>spamd</code> process.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of children per <code>spamd</code> process.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxconnperchild" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">maxconnperchild</span></td><td class="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">maxconnperchild=200</span></div><div><div html="<p>The maximum number of connections that the <code>spamd</code> daemon allows per child process.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of connections that the <code>spamd</code> daemon allows per child process.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="pidfile" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">pidfile</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">pidfile=/var/run/spamd.pid</span></div><div><div html="<p>The process ID&#39;s file path.</p>
<p><strong>Warning:</strong></p>
<p>This parameter changes the <code>spamd</code> daemon&#39;s process ID filepath. On
systems that use the <code>systemd</code> daemon, you must update the <code>PIDFile</code>
parameter in the <code>spamd.service</code> definition. If you do not update the
<code>PIDFile</code> parameter, the <code>spamd</code> daemon will fail to function because the
PID path and the <code>PIDFile</code> parameter will not match.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The process ID's file path.</p>
<p><strong>Warning:</strong></p>
<p>This parameter changes the <code>spamd</code> daemon's process ID filepath. On
systems that use the <code>systemd</code> daemon, you must update the <code>PIDFile</code>
parameter in the <code>spamd.service</code> definition. If you do not update the
<code>PIDFile</code> parameter, the <code>spamd</code> daemon will fail to function because the
PID path and the <code>PIDFile</code> parameter will not match.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="timeoutchild" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">timeoutchild</span></td><td class="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">timeoutchild=300</span></div><div><div html="<p>The maximum amount of time that a child process waits before it abandons a TCP connection.</p>
<p><strong>Note:</strong></p>
<p>If the value of this parameter is <code>0</code>, child processes will <strong>not</strong> abandon TCP connections.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum amount of time that a child process waits before it abandons a TCP connection.</p>
<p><strong>Note:</strong></p>
<p>If the value of this parameter is <code>0</code>, child processes will <strong>not</strong> abandon TCP connections.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="timeouttcp" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">timeouttcp</span></td><td class="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">timeouttcp=30</span></div><div><div html="<p>The maximum amount of time that the <code>spamd</code> daemon waits before it abandons a TCP connection.</p>
<p><strong>Note:</strong></p>
<p>If the value of this parameter is <code>0</code>, <code>spamd</code> will <strong>not</strong> abandon TCP connections.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum amount of time that the <code>spamd</code> daemon waits before it abandons a TCP connection.</p>
<p><strong>Note:</strong></p>
<p>If the value of this parameter is <code>0</code>, <code>spamd</code> will <strong>not</strong> abandon TCP connections.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/save_spamd_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/save_spamd_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:R4kv99q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kv99q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kv99q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kv99q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kv99q:0" aria-labelledby="tab:R4kv99q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
save_spamd_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kv99q:1" aria-labelledby="tab:R4kv99q: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:R4sv99q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sv99q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sv99q:0" aria-labelledby="tab:R4sv99q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"save_spamd_config"</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/Spam-Protection-(Greylisting)" data-section-id="tag/Spam-Protection-(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-Protection-(Greylisting)" aria-label="tag/Spam-Protection-(Greylisting)"></a>Spam Protection (Greylisting)</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Mail / Spam Protection (Greylisting)</p>
"><p>Mail / Spam Protection (Greylisting)</p>
</div></div></div><div id="tag/Spam-Protection-(Greylisting)/operation/delete_cpgreylist_trusted_host" data-section-id="tag/Spam-Protection-(Greylisting)/operation/delete_cpgreylist_trusted_host" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_cpgreylist_trusted_host" id="operation/delete_cpgreylist_trusted_host" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/delete_cpgreylist_trusted_host" aria-label="tag/Spam-Protection-(Greylisting)/operation/delete_cpgreylist_trusted_host"></a>Remove IP address from Greylisting trusted hosts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deletes an IP address from the Greylisting <em>Trusted Hosts</em> list.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes an IP address from the Greylisting <em>Trusted Hosts</em> list.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=ip-1=192.168.0.1&ip-2=192.168.0.2&ip-3=192.168.0.3</span> -<!-- --> <!-- -->Multiple IP addresses.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=192.168.0.1</span> -<!-- --> <!-- -->A single IP address.</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></ul><div><div html="<p>The record&#39;s IP address, or a range of IP addresses.</p>
<p><strong>Note:</strong></p>
<p>To add multiple IP addresses, increment the parameter name (for example, <code>ip-1</code>, <code>ip-2</code>, <code>ip-3</code>).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The record's IP address, or a range of IP addresses.</p>
<p><strong>Note:</strong></p>
<p>To add multiple IP addresses, increment the parameter name (for example, <code>ip-1</code>, <code>ip-2</code>, <code>ip-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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/delete_cpgreylist_trusted_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/delete_cpgreylist_trusted_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:R993b9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R993b9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R993b9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R993b9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R993b9q:0" aria-labelledby="tab:R993b9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
delete_cpgreylist_trusted_host <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'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R993b9q:1" aria-labelledby="tab:R993b9q: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:R9p3b9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p3b9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p3b9q:0" aria-labelledby="tab:R9p3b9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ips_failed"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"5.5"</span>: <span class="token string">"Invalid IP address or range: “5.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">"ips_removed"</span>: <button class="collapser" aria-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><li><div class="hoverable "><span class="token string">"2001:db8::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">"metadata"</span>: <button class="collapser" aria-label="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">"delete_cpgreylist_trusted_host"</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/Spam-Protection-(Greylisting)/operation/cPGreyList-create_cpgreylist_trusted_host" data-section-id="tag/Spam-Protection-(Greylisting)/operation/cPGreyList-create_cpgreylist_trusted_host" class="sc-dntaoT ceciOs"><div data-section-id="operation/cPGreyList-create_cpgreylist_trusted_host" id="operation/cPGreyList-create_cpgreylist_trusted_host" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/cPGreyList-create_cpgreylist_trusted_host" aria-label="tag/Spam-Protection-(Greylisting)/operation/cPGreyList-create_cpgreylist_trusted_host"></a>Add IP address to Greylisting trusted hosts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds an IP address to the <em>Greylisting Trusted Hosts</em> list.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds an IP address to the <em>Greylisting Trusted Hosts</em> list.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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><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">comment=NoComment</span></div><div><div html="<p>A comment.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comment.</p>
</div></div></div></td></tr><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=ip-1=192.168.0.1&ip-2=192.168.0.2&ip-3=192.168.0.3</span> -<!-- --> <!-- -->To add multiple IP addresses.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=192.168.0.1</span> -<!-- --> <!-- -->To add a single IP address.</li></ul><div><div html="<p>The record&#39;s IP address, or a range of IP addresses.</p>
<p><strong>Note:</strong></p>
<p>To add multiple IP addresses, increment the parameter name. For example, <code>ip-1</code>, <code>ip-2</code>, and <code>ip-3</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The record's IP address, or a range of IP addresses.</p>
<p><strong>Note:</strong></p>
<p>To add multiple IP addresses, increment the parameter name. For example, <code>ip-1</code>, <code>ip-2</code>, and <code>ip-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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/create_cpgreylist_trusted_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/create_cpgreylist_trusted_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:R995b9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R995b9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R995b9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R995b9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R995b9q:0" aria-labelledby="tab:R995b9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
create_cpgreylist_trusted_host <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'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R995b9q:1" aria-labelledby="tab:R995b9q: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:R9p5b9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p5b9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p5b9q:0" aria-labelledby="tab:R9p5b9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"comment"</span>: <span class="token string">"NoComment"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ips_added"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"comment"</span>: <span class="token string">"Fascinating"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_time"</span>: <span class="token string">"2015-02-17T10:08:26.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host_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">"id"</span>: <span class="token number">42</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ips_failed"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"comment"</span>: <span class="token string">"Sorry, 192.168 is not a valid IP address."</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"create_cpgreylist_trusted_host"</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/Spam-Protection-(Greylisting)/operation/cpgreylist_is_server_netblock_trusted" data-section-id="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_is_server_netblock_trusted" class="sc-dntaoT ceciOs"><div data-section-id="operation/cpgreylist_is_server_netblock_trusted" id="operation/cpgreylist_is_server_netblock_trusted" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/cpgreylist_is_server_netblock_trusted" aria-label="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_is_server_netblock_trusted"></a>Return Greylisting trust status of server netblock<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the Greylisting trusted status of the server&#39;s netblock.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the Greylisting trusted status of the server's netblock.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/cpgreylist_is_server_netblock_trusted</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/cpgreylist_is_server_netblock_trusted</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R997b9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R997b9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R997b9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R997b9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R997b9q:0" aria-labelledby="tab:R997b9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
cpgreylist_is_server_netblock_trusted
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R997b9q:1" aria-labelledby="tab:R997b9q: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:R9p7b9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p7b9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p7b9q:0" aria-labelledby="tab:R9p7b9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ip_blocks"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"10.0.0.0-10.255.255.255"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"199.0.0.0-199.3.255.255"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"48.0.0.0-48.255.255.255"</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">"metadata"</span>: <button class="collapser" aria-label="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">"cpgreylist_is_server_netblock_trusted"</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/Spam-Protection-(Greylisting)/operation/cpgreylist_list_entries_for_common_mail_provider" data-section-id="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_list_entries_for_common_mail_provider" class="sc-dntaoT ceciOs"><div data-section-id="operation/cpgreylist_list_entries_for_common_mail_provider" id="operation/cpgreylist_list_entries_for_common_mail_provider" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/cpgreylist_list_entries_for_common_mail_provider" aria-label="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_list_entries_for_common_mail_provider"></a>Return Greylisting IP addresses of mail providers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists Greylisting&#39;s IP addresses for the specified mail provider.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists Greylisting's IP addresses for the specified mail 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="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> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=provider-0=example-0 provider-1=example-1 provider-2=example-2</span> -<!-- --> <!-- -->List multiple mail provider entries.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=cpanel</span> -<!-- --> <!-- -->List a single mail provider entry.</li></ul><div><div html="<p>The mail provider.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To list entries for multiple mail providers, increment the parameter name. For example, <code>provider-0</code>, <code>provider-1</code>, and <code>provider-2</code>.</li>
<li>Call WHM API 1&#39;s <code>cpgreylist_load_common_mail_providers_config</code> function to return a list of valid provider keys.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail provider.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To list entries for multiple mail providers, increment the parameter name. For example, <code>provider-0</code>, <code>provider-1</code>, and <code>provider-2</code>.</li>
<li>Call WHM API 1's <code>cpgreylist_load_common_mail_providers_config</code> function to return a list of valid provider keys.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/cpgreylist_list_entries_for_common_mail_provider</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/cpgreylist_list_entries_for_common_mail_provider</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R999b9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R999b9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R999b9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R999b9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R999b9q:0" aria-labelledby="tab:R999b9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
cpgreylist_list_entries_for_common_mail_provider <span class="token punctuation">\</span>
<span class="token assign-left variable">provider</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:R999b9q:1" aria-labelledby="tab:R999b9q: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:R9p9b9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p9b9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p9b9q:0" aria-labelledby="tab:R9p9b9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"providers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cpanel"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ips"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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 string">"2015-07-28T08:16:52"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host_ip"</span>: <span class="token string">"208.115.214.0-208.115.214.255"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_trusted"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_id"</span>: <span class="token number">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">"create_time"</span>: <span class="token string">"2015-07-28T08:16:52"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host_ip"</span>: <span class="token string">"74.63.202.0-74.63.202.255"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_trusted"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_id"</span>: <span class="token number">7</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">"providers_failed"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dpanel"</span>: <span class="token string">"Unknown mail provider: dpanel"</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"cpgreylist_list_entries_for_common_mail_provider"</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/Spam-Protection-(Greylisting)/operation/cpgreylist_load_common_mail_providers_config" data-section-id="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_load_common_mail_providers_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/cpgreylist_load_common_mail_providers_config" id="operation/cpgreylist_load_common_mail_providers_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/cpgreylist_load_common_mail_providers_config" aria-label="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_load_common_mail_providers_config"></a>Return Greylisting mail providers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns Greylisting&#39;s list of common mail service providers.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns Greylisting's list of common mail service 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/cpgreylist_load_common_mail_providers_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/cpgreylist_load_common_mail_providers_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:R99bb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99bb9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99bb9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99bb9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99bb9q:0" aria-labelledby="tab:R99bb9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
cpgreylist_load_common_mail_providers_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99bb9q:1" aria-labelledby="tab:R99bb9q: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:R9pbb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pbb9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pbb9q:0" aria-labelledby="tab:R9pbb9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"autotrust_new_common_mail_providers"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"common_mail_providers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cpanel"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"autoupdate"</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">"cPanel"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_trusted"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sectigo"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"autoupdate"</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">"Comodo/Sectigo"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_trusted"</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">"metadata"</span>: <button class="collapser" aria-label="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">"cpgreylist_load_common_mail_providers_config"</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/Spam-Protection-(Greylisting)/operation/cpgreylist_save_common_mail_providers_config" data-section-id="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_save_common_mail_providers_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/cpgreylist_save_common_mail_providers_config" id="operation/cpgreylist_save_common_mail_providers_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/cpgreylist_save_common_mail_providers_config" aria-label="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_save_common_mail_providers_config"></a>Update Greylisting new mail provider handling<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets whether Greylisting trusts new entries to cPanel&#39;s common mail providers list.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets whether Greylisting trusts new entries to cPanel's common mail providers list.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="autotrust_new_common_mail_providers" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">autotrust_new_common_mail_providers</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">autotrust_new_common_mail_providers=1</span></div><div><div html="<p>Whether Greylisting automatically trusts new mail providers that cPanel adds to the common mail providers list.</p>
<ul>
<li><code>1</code> — Automatically trust new mail providers cPanel adds to the common mail providers list.</li>
<li><code>0</code> — Do <strong>not</strong> automatically trust new mail providers cPanel adds to the common mail providers list.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether Greylisting automatically trusts new mail providers that cPanel adds to the common mail providers list.</p>
<ul>
<li><code>1</code> — Automatically trust new mail providers cPanel adds to the common mail providers list.</li>
<li><code>0</code> — Do <strong>not</strong> automatically trust new mail providers cPanel adds to the common mail providers list.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="PROVIDERKEY" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">PROVIDERKEY</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">PROVIDERKEY=0</span></div><div><div html="<p>Whether Greylisting automatically trusts new IP addresses that cPanel adds to this mail provider.</p>
<ul>
<li><code>1</code> — Automatically trust new IP addresses cPanel adds to this mail provider.</li>
<li><code>0</code> — Do <strong>not</strong> automatically trust new IP addresses cPanel adds to this mail provider.</li>
</ul>
<p>If you do not specify this parameter, the system will <strong>not</strong> change Greylisting settings for <strong>any</strong> existing provider.</p>
<p><strong>Note:</strong></p>
<p> The parameter&#39;s name is the provider&#39;s key name.
Example key and value:</p>
<ul>
<li><code>google=0</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether Greylisting automatically trusts new IP addresses that cPanel adds to this mail provider.</p>
<ul>
<li><code>1</code> — Automatically trust new IP addresses cPanel adds to this mail provider.</li>
<li><code>0</code> — Do <strong>not</strong> automatically trust new IP addresses cPanel adds to this mail provider.</li>
</ul>
<p>If you do not specify this parameter, the system will <strong>not</strong> change Greylisting settings for <strong>any</strong> existing provider.</p>
<p><strong>Note:</strong></p>
<p> The parameter's name is the provider's key name.
Example key and value:</p>
<ul>
<li><code>google=0</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/cpgreylist_save_common_mail_providers_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/cpgreylist_save_common_mail_providers_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:R99db9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99db9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99db9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99db9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99db9q:0" aria-labelledby="tab:R99db9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
cpgreylist_save_common_mail_providers_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99db9q:1" aria-labelledby="tab:R99db9q: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:R9pdb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pdb9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pdb9q:0" aria-labelledby="tab:R9pdb9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"autotrust_new_common_mail_providers"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"common_mail_providers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cpanel"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"autoupdate"</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">"cPanel"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_trusted"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sectigo"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"autoupdate"</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">"Comodo/Sectigo"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_trusted"</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">"metadata"</span>: <button class="collapser" aria-label="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">"cpgreylist_load_common_mail_providers_config"</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/Spam-Protection-(Greylisting)/operation/cpgreylist_status" data-section-id="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/cpgreylist_status" id="operation/cpgreylist_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/cpgreylist_status" aria-label="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_status"></a>Return Greylisting status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the status of Greylisting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the status of Greylisting.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/cpgreylist_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/cpgreylist_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:R99fb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99fb9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99fb9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99fb9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99fb9q:0" aria-labelledby="tab:R99fb9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
cpgreylist_status
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99fb9q:1" aria-labelledby="tab:R99fb9q: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:R9pfb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pfb9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pfb9q:0" aria-labelledby="tab:R9pfb9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"is_exim_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"cPGreyList"</span></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">"command"</span>: <span class="token string">"cpgreylist_status"</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/Spam-Protection-(Greylisting)/operation/disable_cpgreylist" data-section-id="tag/Spam-Protection-(Greylisting)/operation/disable_cpgreylist" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_cpgreylist" id="operation/disable_cpgreylist" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/disable_cpgreylist" aria-label="tag/Spam-Protection-(Greylisting)/operation/disable_cpgreylist"></a>Disable Greylisting<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function disables Greylisting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables Greylisting.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/disable_cpgreylist</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/disable_cpgreylist</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99hb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99hb9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99hb9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99hb9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99hb9q:0" aria-labelledby="tab:R99hb9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
disable_cpgreylist
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99hb9q:1" aria-labelledby="tab:R99hb9q: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:R9phb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9phb9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9phb9q:0" aria-labelledby="tab:R9phb9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"disable_cpgreylist"</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/Spam-Protection-(Greylisting)/operation/cpgreylist_trust_entries_for_common_mail_provider" data-section-id="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_trust_entries_for_common_mail_provider" class="sc-dntaoT ceciOs"><div data-section-id="operation/cpgreylist_trust_entries_for_common_mail_provider" id="operation/cpgreylist_trust_entries_for_common_mail_provider" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/cpgreylist_trust_entries_for_common_mail_provider" aria-label="tag/Spam-Protection-(Greylisting)/operation/cpgreylist_trust_entries_for_common_mail_provider"></a>Add mail provider to Greylisting trusted hosts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function marks the IP addresses for the specified mail provider as trusted. Greylisting will not defer emails from trusted IP addresses.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function marks the IP addresses for the specified mail provider as trusted. Greylisting will not defer emails from trusted IP 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="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> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=provider-1=cpanel&provider-2=google</span> -<!-- --> <!-- -->Trust multiple mail providers.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=cpanel</span> -<!-- --> <!-- -->Trust a single mail provider.</li></ul><div><div html="<p>The mail providers’ names.</p>
<p>Call the <code>cpgreylist_load_common_mail_providers_config</code> API function
to retrieve the system’s recognized provider names.</p>
<p><strong>Note:</strong></p>
<p> To trust multiple mail providers, increment the parameter name (for example: <code>provider-0</code>, <code>provider-1</code>, and <code>provider-2</code>).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail providers’ names.</p>
<p>Call the <code>cpgreylist_load_common_mail_providers_config</code> API function
to retrieve the system’s recognized provider names.</p>
<p><strong>Note:</strong></p>
<p> To trust multiple mail providers, increment the parameter name (for example: <code>provider-0</code>, <code>provider-1</code>, and <code>provider-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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/cpgreylist_trust_entries_for_common_mail_provider</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/cpgreylist_trust_entries_for_common_mail_provider</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99jb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99jb9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99jb9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99jb9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99jb9q:0" aria-labelledby="tab:R99jb9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
cpgreylist_trust_entries_for_common_mail_provider <span class="token punctuation">\</span>
<span class="token assign-left variable">provider</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:R99jb9q:1" aria-labelledby="tab:R99jb9q: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:R9pjb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pjb9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pjb9q:0" aria-labelledby="tab:R9pjb9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"providers_failed"</span>: <button class="collapser" aria-label="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>: <span class="token string">"This failed because it rained."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"property2"</span>: <span class="token string">"This failed because it rained."</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"providers_trusted"</span>: <button class="collapser" aria-label="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">"ips_trusted"</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">"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">"ips_trusted"</span>: <span class="token number">21</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">"metadata"</span>: <button class="collapser" aria-label="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">"cpgreylist_trust_entries_for_common_mail_provider"</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/Spam-Protection-(Greylisting)/operation/load_cpgreylist_config" data-section-id="tag/Spam-Protection-(Greylisting)/operation/load_cpgreylist_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/load_cpgreylist_config" id="operation/load_cpgreylist_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/load_cpgreylist_config" aria-label="tag/Spam-Protection-(Greylisting)/operation/load_cpgreylist_config"></a>Return Greylisting settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns Greylisting&#39;s current settings.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns Greylisting's current 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/load_cpgreylist_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/load_cpgreylist_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:R99lb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99lb9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99lb9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99lb9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99lb9q:0" aria-labelledby="tab:R99lb9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
load_cpgreylist_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99lb9q:1" aria-labelledby="tab:R99lb9q: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:R9plb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9plb9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9plb9q:0" aria-labelledby="tab:R9plb9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_config"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"child_timeout_secs"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"initial_block_time_mins"</span>: <span class="token number">10</span><span class="token punctuation">,</span></div></li><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">"is_exim_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_child_procs"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"must_try_time_mins"</span>: <span class="token number">240</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"purge_interval_mins"</span>: <span class="token number">60</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"record_exp_time_mins"</span>: <span class="token number">4320</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spf_bypass"</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">"metadata"</span>: <button class="collapser" aria-label="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">"load_cpgreylist_config"</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/Spam-Protection-(Greylisting)/operation/save_cpgreylist_config" data-section-id="tag/Spam-Protection-(Greylisting)/operation/save_cpgreylist_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/save_cpgreylist_config" id="operation/save_cpgreylist_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/save_cpgreylist_config" aria-label="tag/Spam-Protection-(Greylisting)/operation/save_cpgreylist_config"></a>Update Greylisting settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function modifies the server&#39;s Greylisting configuration settings.</p>
<p><strong>Important:</strong></p>
<p>When you call this function, you <strong>must</strong> include at least one of the
following parameters:</p>
<ul>
<li><code>spf_bypass</code></li>
<li><code>child_timeout_secs</code></li>
<li><code>record_exp_time_mins</code></li>
<li><code>initial_block_time_mins</code></li>
<li><code>max_child_procs</code></li>
<li><code>purge_interval_mins</code></li>
<li><code>must_try_time_mins</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies the server's Greylisting configuration settings.</p>
<p><strong>Important:</strong></p>
<p>When you call this function, you <strong>must</strong> include at least one of the
following parameters:</p>
<ul>
<li><code>spf_bypass</code></li>
<li><code>child_timeout_secs</code></li>
<li><code>record_exp_time_mins</code></li>
<li><code>initial_block_time_mins</code></li>
<li><code>max_child_procs</code></li>
<li><code>purge_interval_mins</code></li>
<li><code>must_try_time_mins</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="child_timeout_secs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">child_timeout_secs</span></td><td class="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">child_timeout_secs=5</span></div><div><div html="<p>The maximum of seconds that Greylisting waits for a child process to timeout.</p>
<p><strong>Note:</strong></p>
<p>This parameter affects the function of the <code>cPGreyList</code> daemon. Do <strong>not</strong> change this
value unless it is absolutely necessary.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum of seconds that Greylisting waits for a child process to timeout.</p>
<p><strong>Note:</strong></p>
<p>This parameter affects the function of the <code>cPGreyList</code> daemon. Do <strong>not</strong> change this
value unless it is absolutely necessary.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="initial_block_time_mins" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">initial_block_time_mins</span></td><td class="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 .. 240 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">initial_block_time_mins=10</span></div><div><div html="<p>The number of minutes during which Greylisting defers email from an unknown triplet. The maximum value for this parameter is four hours (<code>240</code> minutes).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of minutes during which Greylisting defers email from an unknown triplet. The maximum value for this parameter is four hours (<code>240</code> minutes).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="max_child_procs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">max_child_procs</span></td><td class="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">max_child_procs=5</span></div><div><div html="<p>The maximum number of child processes.</p>
<p><strong>Notes:</strong></p>
<p> This parameter affects the function of the <code>cPGreyList</code> daemon. Do <strong>not</strong> change this
value unless it is absolutely necessary.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of child processes.</p>
<p><strong>Notes:</strong></p>
<p> This parameter affects the function of the <code>cPGreyList</code> daemon. Do <strong>not</strong> change this
value unless it is absolutely necessary.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="must_try_time_mins" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">must_try_time_mins</span></td><td class="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 .. 1440 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">must_try_time_mins=240</span></div><div><div html="<p>The number of minutes during which Greylisting accepts a re-sent email from an unknown triplet. The maximum value for this parameter is one day (<code>1440</code> minutes).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of minutes during which Greylisting accepts a re-sent email from an unknown triplet. The maximum value for this parameter is one day (<code>1440</code> minutes).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="purge_interval_mins" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">purge_interval_mins</span></td><td class="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">purge_interval_mins=60</span></div><div><div html="<p>The number of minutes before Greylisting deletes the records in the Greylisting database.</p>
<p><strong>Note:</strong></p>
<p>This parameter affects the function of the <code>cPGreyList</code> daemon. Do <strong>not</strong> change this
value unless it is absolutely necessary.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of minutes before Greylisting deletes the records in the Greylisting database.</p>
<p><strong>Note:</strong></p>
<p>This parameter affects the function of the <code>cPGreyList</code> daemon. Do <strong>not</strong> change this
value unless it is absolutely necessary.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="record_exp_time_mins" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">record_exp_time_mins</span></td><td class="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 .. 43200 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">record_exp_time_mins=4320</span></div><div><div html="<p>The number of minutes before Greylisting deletes the triplet record and treats a
re-sent email as coming from a new, unknown triplet. The maximum value for this
parameter is 30 days (<code>43200</code> minutes).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of minutes before Greylisting deletes the triplet record and treats a
re-sent email as coming from a new, unknown triplet. The maximum value for this
parameter is 30 days (<code>43200</code> minutes).</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="spf_bypass" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">spf_bypass</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">spf_bypass=1</span></div><div><div html="<p>Whether emails with SPF bypass Greylisting.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether emails with SPF bypass Greylisting.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/save_cpgreylist_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/save_cpgreylist_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:R99nb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99nb9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99nb9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99nb9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99nb9q:0" aria-labelledby="tab:R99nb9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
save_cpgreylist_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99nb9q:1" aria-labelledby="tab:R99nb9q: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:R9pnb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pnb9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pnb9q:0" aria-labelledby="tab:R9pnb9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_config"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"child_timeout_secs"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"initial_block_time_mins"</span>: <span class="token number">10</span><span class="token punctuation">,</span></div></li><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">"is_exim_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_child_procs"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"must_try_time_mins"</span>: <span class="token number">240</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"purge_interval_mins"</span>: <span class="token number">60</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"record_exp_time_mins"</span>: <span class="token number">4320</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spf_bypass"</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">"metadata"</span>: <button class="collapser" aria-label="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">"save_cpgreylist_config"</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/Spam-Protection-(Greylisting)/operation/cPGreyList-cpgreylist_untrust_entries_for_common_mail_provider" data-section-id="tag/Spam-Protection-(Greylisting)/operation/cPGreyList-cpgreylist_untrust_entries_for_common_mail_provider" class="sc-dntaoT ceciOs"><div data-section-id="operation/cPGreyList-cpgreylist_untrust_entries_for_common_mail_provider" id="operation/cPGreyList-cpgreylist_untrust_entries_for_common_mail_provider" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/cPGreyList-cpgreylist_untrust_entries_for_common_mail_provider" aria-label="tag/Spam-Protection-(Greylisting)/operation/cPGreyList-cpgreylist_untrust_entries_for_common_mail_provider"></a>Add mail provider to Greylisting non-trusted hosts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function marks the IP addresses for the specified mail provider as not trusted.
Greylisting defers emails from non-trusted IP addresses.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function marks the IP addresses for the specified mail provider as not trusted.
Greylisting defers emails from non-trusted IP 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="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> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=provider-1=10 provider-2=33 provider-3=15</span> -<!-- --> <!-- -->Trust multiple mail providers</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=1</span> -<!-- --> <!-- -->Trust a single mail provider</li></ul><div><div html="<p>The mail provider.</p>
<p><strong>Note:</strong></p>
<p>To trust multiple mail providers,
increment the parameter name. For example, provider-0, provider-1, provider-2.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail provider.</p>
<p><strong>Note:</strong></p>
<p>To trust multiple mail providers,
increment the parameter name. For example, provider-0, provider-1, provider-2.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/cpgreylist_untrust_entries_for_common_mail_provider</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/cpgreylist_untrust_entries_for_common_mail_provider</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99pb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99pb9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99pb9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99pb9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99pb9q:0" aria-labelledby="tab:R99pb9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
cpgreylist_untrust_entries_for_common_mail_provider <span class="token punctuation">\</span>
<span class="token assign-left variable">provider</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:R99pb9q:1" aria-labelledby="tab:R99pb9q: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:R9ppb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ppb9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ppb9q:0" aria-labelledby="tab:R9ppb9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"providers_failed"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"provider_key1"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ips_untrusted"</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">"provider_key2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ips_untrusted"</span>: <span class="token number">21</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"providers_untrusted"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"provider_key1"</span>: <span class="token string">"Unknown mail provider."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_key2"</span>: <span class="token string">"Unknown mail provider."</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"cpgreylist_untrust_entries_for_common_mail_provider"</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/Spam-Protection-(Greylisting)/operation/cPGreyList-read_cpgreylist_deferred_entries" data-section-id="tag/Spam-Protection-(Greylisting)/operation/cPGreyList-read_cpgreylist_deferred_entries" class="sc-dntaoT ceciOs"><div data-section-id="operation/cPGreyList-read_cpgreylist_deferred_entries" id="operation/cPGreyList-read_cpgreylist_deferred_entries" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/cPGreyList-read_cpgreylist_deferred_entries" aria-label="tag/Spam-Protection-(Greylisting)/operation/cPGreyList-read_cpgreylist_deferred_entries"></a>Return Greylisting deferred incoming email triplets<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists Greylisting&#39;s deferred triplets.
Greylisting identifies incoming email by triplets.</p>
<p>A triplet is a collection of three pieces of data:</p>
<ul>
<li>the IP address</li>
<li>the sender&#39;s address</li>
<li>the recipient&#39;s address</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists Greylisting's deferred triplets.
Greylisting identifies incoming email by triplets.</p>
<p>A triplet is a collection of three pieces of data:</p>
<ul>
<li>the IP address</li>
<li>the sender's address</li>
<li>the recipient's address</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/read_cpgreylist_deferred_entries</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/read_cpgreylist_deferred_entries</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99rb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99rb9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99rb9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99rb9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99rb9q:0" aria-labelledby="tab:R99rb9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
read_cpgreylist_deferred_entries
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99rb9q:1" aria-labelledby="tab:R99rb9q: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:R9prb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9prb9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9prb9q:0" aria-labelledby="tab:R9prb9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"greylist_deferred_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">"accepted_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"block_exp_time"</span>: <span class="token string">"2015-03-23T12:09:32.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_time"</span>: <span class="token string">"2015-03-23T11:59:32.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deferred_count"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"from_addr"</span>: <span class="token string">"fromaddress1.com@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">45</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"must_retry_by"</span>: <span class="token string">"2015-03-23T15:59:32.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"record_exp_time"</span>: <span class="token string">"2015-03-26T11:59:32.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sender_ip"</span>: <span class="token string">"97.215.255.29"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"to_addr"</span>: <span class="token string">"toaddress1.com@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">"limit"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"offset"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server_timezone"</span>: <span class="token string">"CDT"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server_tzoffset"</span>: <span class="token number">60</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total_rows"</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">"metadata"</span>: <button class="collapser" aria-label="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">"read_cpgreylist_deferred_entries"</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/Spam-Protection-(Greylisting)/operation/enable_cpgreylist" data-section-id="tag/Spam-Protection-(Greylisting)/operation/enable_cpgreylist" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_cpgreylist" id="operation/enable_cpgreylist" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/enable_cpgreylist" aria-label="tag/Spam-Protection-(Greylisting)/operation/enable_cpgreylist"></a>Enable Greylisting<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables Greylisting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables Greylisting.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/enable_cpgreylist</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/enable_cpgreylist</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99tb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99tb9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99tb9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99tb9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99tb9q:0" aria-labelledby="tab:R99tb9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
enable_cpgreylist
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99tb9q:1" aria-labelledby="tab:R99tb9q: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:R9ptb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ptb9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ptb9q:0" aria-labelledby="tab:R9ptb9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"enable_cpgreylist"</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/Spam-Protection-(Greylisting)/operation/read_cpgreylist_trusted_hosts" data-section-id="tag/Spam-Protection-(Greylisting)/operation/read_cpgreylist_trusted_hosts" class="sc-dntaoT ceciOs"><div data-section-id="operation/read_cpgreylist_trusted_hosts" id="operation/read_cpgreylist_trusted_hosts" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Protection-(Greylisting)/operation/read_cpgreylist_trusted_hosts" aria-label="tag/Spam-Protection-(Greylisting)/operation/read_cpgreylist_trusted_hosts"></a>Return Greylisting trusted hosts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the entries on the Greylisting Trusted Hosts list.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the entries on the Greylisting Trusted Hosts list.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/read_cpgreylist_trusted_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/read_cpgreylist_trusted_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:R99vb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99vb9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99vb9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99vb9q:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99vb9q:0" aria-labelledby="tab:R99vb9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
read_cpgreylist_trusted_hosts
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99vb9q:1" aria-labelledby="tab:R99vb9q: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:R9pvb9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pvb9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pvb9q:0" aria-labelledby="tab:R9pvb9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"greylist_trusted_hosts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"comment"</span>: <span class="token string">"Example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_time"</span>: <span class="token string">"2015-03-24T10:22:38.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host_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">"id"</span>: <span class="token number">19</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">"metadata"</span>: <button class="collapser" aria-label="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">"read_cpgreylist_trusted_hosts"</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/NGINX-Manager" data-section-id="tag/NGINX-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/NGINX-Manager" aria-label="tag/NGINX-Manager"></a>NGINX Manager</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>The NGINX Manager module for WHM API 1.</p>
"><p>The NGINX Manager module for WHM API 1.</p>
</div></div></div><div id="tag/NGINX-Manager/operation/nginxmanager_clear_cache" data-section-id="tag/NGINX-Manager/operation/nginxmanager_clear_cache" class="sc-dntaoT ceciOs"><div data-section-id="operation/nginxmanager_clear_cache" id="operation/nginxmanager_clear_cache" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/NGINX-Manager/operation/nginxmanager_clear_cache" aria-label="tag/NGINX-Manager/operation/nginxmanager_clear_cache"></a>Delete the user's NGINX cache.<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function clears a user&#39;s NGINX cache</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function clears a user's NGINX cache</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->username<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->username<!-- --> ></span> ]</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">user=unclebob&user=auntsue</span></div><div><div html="<p>A list of users whose cache you want to clear.</p>
<p><strong>Note:</strong></p>
<p>If you do not pass this parameter, this function clears the cache for all users.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of users whose cache you want to clear.</p>
<p><strong>Note:</strong></p>
<p>If you do not pass this parameter, this function clears the cache for all 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="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">/nginxmanager_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/nginxmanager_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:R154raa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154raa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154raa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154raa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154raa:0" aria-labelledby="tab:R154raa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
nginxmanager_clear_cache
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154raa:1" aria-labelledby="tab:R154raa: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:R174raa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174raa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174raa:0" aria-labelledby="tab:R174raa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"nginxmanager_clear_cache"</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/NGINX-Manager/operation/nginxmanager_set_cache_config" data-section-id="tag/NGINX-Manager/operation/nginxmanager_set_cache_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/nginxmanager_set_cache_config" id="operation/nginxmanager_set_cache_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/NGINX-Manager/operation/nginxmanager_set_cache_config" aria-label="tag/NGINX-Manager/operation/nginxmanager_set_cache_config"></a>Update NGINX caching status.<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables or disables NGINX caching.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables or disables NGINX caching.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><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><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">enabled=1</span></div><div><div html="<p>Whether to enable to disable caching.</p>
<p><strong>Note:</strong></p>
<ul>
<li><code>1</code> - Enables caching.</li>
<li><code>0</code> - Disables caching.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable to disable caching.</p>
<p><strong>Note:</strong></p>
<ul>
<li><code>1</code> - Enables caching.</li>
<li><code>0</code> - Disables caching.</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></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"> <!-- --><<!-- -->username<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->username<!-- --> ></span> ]</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">user=unclebob&user=auntsue</span></div><div><div html="<p>A list of users whose caching you want to enable or disable.</p>
<p><strong>Note:</strong></p>
<p>If you do not pass this parameter, this function sets the caching status for all users on the system.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of users whose caching you want to enable or disable.</p>
<p><strong>Note:</strong></p>
<p>If you do not pass this parameter, this function sets the caching status for all users on the system.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/nginxmanager_set_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/nginxmanager_set_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:R155baa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155baa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155baa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155baa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155baa:0" aria-labelledby="tab:R155baa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
nginxmanager_set_cache_config <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:R155baa:1" aria-labelledby="tab:R155baa: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:R175baa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175baa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175baa:0" aria-labelledby="tab:R175baa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"nginxmanager_set_cache_config"</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/NGINX-Manager/operation/nginxmanager_get_cache_config_users" data-section-id="tag/NGINX-Manager/operation/nginxmanager_get_cache_config_users" class="sc-dntaoT ceciOs"><div data-section-id="operation/nginxmanager_get_cache_config_users" id="operation/nginxmanager_get_cache_config_users" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/NGINX-Manager/operation/nginxmanager_get_cache_config_users" aria-label="tag/NGINX-Manager/operation/nginxmanager_get_cache_config_users"></a>Return user NGINX caching configurations.<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a user&#39;s NGINX cache configuration.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a user's NGINX cache 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><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="merge" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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"> <!-- -->Value<!-- -->:</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">merge=1</span></div><div><div html="<p>Combine default, system, and user NGINX configurations when returning configuration data.</p>
<p><strong>Note:</strong></p>
<ul>
<li><code>1</code> - Return the configuration with default, system, and user values combined.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Combine default, system, and user NGINX configurations when returning configuration data.</p>
<p><strong>Note:</strong></p>
<ul>
<li><code>1</code> - Return the configuration with default, system, and user values combined.</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></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"> <!-- --><<!-- -->username<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->username<!-- --> ></span> ]</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">user=unclebob&user=auntsue</span></div><div><div html="<p>A list of users whose cache configuration you want to retrieve.</p>
<p><strong>Note:</strong></p>
<p>If you do not pass this parameter, this function retrieves the cache configuration for all users.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of users whose cache configuration you want to retrieve.</p>
<p><strong>Note:</strong></p>
<p>If you do not pass this parameter, this function retrieves the cache configuration for all 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/nginxmanager_get_cache_config_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/nginxmanager_get_cache_config_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:R155raa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155raa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155raa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155raa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155raa:0" aria-labelledby="tab:R155raa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
nginxmanager_get_cache_config_users
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155raa:1" aria-labelledby="tab:R155raa: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:R175raa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175raa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175raa:0" aria-labelledby="tab:R175raa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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 "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"config"</span>: <button class="collapser" aria-label="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 boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inactive_time"</span>: <span class="token string">"60m"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"levels"</span>: <span class="token string">"1:2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"logging"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_background_update"</span>: <span class="token string">"on"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_lock"</span>: <span class="token string">"on"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_min_uses"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_revalidate"</span>: <span class="token string">"on"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_use_stale"</span>: <span class="token string">"error timeout http_429 http_500 http_502 http_503 http_504"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_cache_header"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"zone_size"</span>: <span class="token string">"10m"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merged"</span>: <span class="token number">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">"user"</span>: <span class="token string">"cptest1"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"config"</span>: <button class="collapser" aria-label="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 boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inactive_time"</span>: <span class="token string">"60m"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"levels"</span>: <span class="token string">"1:2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"logging"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_background_update"</span>: <span class="token string">"on"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_lock"</span>: <span class="token string">"on"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_min_uses"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_revalidate"</span>: <span class="token string">"on"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_use_stale"</span>: <span class="token string">"error timeout http_429 http_500 http_502 http_503 http_504"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_cache_header"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"zone_size"</span>: <span class="token string">"10m"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merged"</span>: <span class="token number">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">"user"</span>: <span class="token string">"cptest2"</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">"metadata"</span>: <button class="collapser" aria-label="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">"nginxmanager_set_config"</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/NGINX-Manager/operation/nginxmanager_reset_users_cache_config" data-section-id="tag/NGINX-Manager/operation/nginxmanager_reset_users_cache_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/nginxmanager_reset_users_cache_config" id="operation/nginxmanager_reset_users_cache_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/NGINX-Manager/operation/nginxmanager_reset_users_cache_config" aria-label="tag/NGINX-Manager/operation/nginxmanager_reset_users_cache_config"></a>Restore NGINX configuration to default values.<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function resets a user to the NGINX system default.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function resets a user to the NGINX system default.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->username<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->username<!-- --> ></span> ]</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">user=unclebob&user=auntsue</span></div><div><div html="<p>A list of users to reset to the NGINX system default.</p>
<p><strong>Note:</strong></p>
<p>If you do not pass this parameter, this function resets the configuration to the default for all users on the system.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of users to reset to the NGINX system default.</p>
<p><strong>Note:</strong></p>
<p>If you do not pass this parameter, this function resets the configuration to the default for all users on the system.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/nginxmanager_reset_users_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/nginxmanager_reset_users_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:R156baa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156baa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156baa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156baa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156baa:0" aria-labelledby="tab:R156baa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
nginxmanager_reset_users_cache_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156baa:1" aria-labelledby="tab:R156baa: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:R176baa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176baa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176baa:0" aria-labelledby="tab:R176baa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"nginxmanager_reset_users_cache_config"</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/NGINX-Manager/operation/nginxmanager_rebuild_cache_config" data-section-id="tag/NGINX-Manager/operation/nginxmanager_rebuild_cache_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/nginxmanager_rebuild_cache_config" id="operation/nginxmanager_rebuild_cache_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/NGINX-Manager/operation/nginxmanager_rebuild_cache_config" aria-label="tag/NGINX-Manager/operation/nginxmanager_rebuild_cache_config"></a>Update NGINX configuration.<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function rebuilds the NGINX user configuration.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function rebuilds the NGINX user 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><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">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->username<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->username<!-- --> ></span> ]</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">user=unclebob&user=auntsue</span></div><div><div html="<p>A list of users whose configuration you want to rebuild.</p>
<p><strong>Note:</strong></p>
<p>If you do not pass this parameter, this function rebuilds the configuration for all users on the system.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of users whose configuration you want to rebuild.</p>
<p><strong>Note:</strong></p>
<p>If you do not pass this parameter, this function rebuilds the configuration for all users on the system.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/nginxmanager_rebuild_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/nginxmanager_rebuild_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:R156raa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156raa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156raa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156raa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156raa:0" aria-labelledby="tab:R156raa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
nginxmanager_rebuild_cache_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156raa:1" aria-labelledby="tab:R156raa: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:R176raa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176raa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176raa:0" aria-labelledby="tab:R176raa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"nginxmanager_rebuild_cache_config"</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/NGINX-Manager/operation/nginxmanager_get_cache_config_system" data-section-id="tag/NGINX-Manager/operation/nginxmanager_get_cache_config_system" class="sc-dntaoT ceciOs"><div data-section-id="operation/nginxmanager_get_cache_config_system" id="operation/nginxmanager_get_cache_config_system" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/NGINX-Manager/operation/nginxmanager_get_cache_config_system" aria-label="tag/NGINX-Manager/operation/nginxmanager_get_cache_config_system"></a>Return NGINX caching configurations.<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the system NGINX cache configuration.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the system NGINX cache 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><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="merge" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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"> <!-- -->Value<!-- -->:</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">merge=1</span></div><div><div html="<p>Whether to combine the default and system NGINX configurations when returning configuration data.</p>
<p><strong>Note:</strong></p>
<ul>
<li><code>1</code> - Return the configuration with default and system values combined.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to combine the default and system NGINX configurations when returning configuration data.</p>
<p><strong>Note:</strong></p>
<ul>
<li><code>1</code> - Return the configuration with default and system values combined.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/nginxmanager_get_cache_config_system</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/nginxmanager_get_cache_config_system</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R157baa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R157baa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R157baa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R157baa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R157baa:0" aria-labelledby="tab:R157baa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
nginxmanager_get_cache_config_system
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R157baa:1" aria-labelledby="tab:R157baa: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:R177baa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R177baa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R177baa:0" aria-labelledby="tab:R177baa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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"</span>: <button class="collapser" aria-label="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">"inactive_time"</span>: <span class="token string">"60m"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"levels"</span>: <span class="token string">"1:2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"logging"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_background_update"</span>: <span class="token string">"on"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_lock"</span>: <span class="token string">"on"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_min_uses"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_revalidate"</span>: <span class="token string">"on"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_use_stale"</span>: <span class="token string">"error timeout http_429 http_500 http_502 http_503 http_504"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_cache_header"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"zone_size"</span>: <span class="token string">"10m"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"system"</span>: <button class="collapser" aria-label="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 boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inactive_time"</span>: <span class="token string">"60m"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"levels"</span>: <span class="token string">"1:2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"logging"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_background_update"</span>: <span class="token string">"on"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_lock"</span>: <span class="token string">"on"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_min_uses"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_revalidate"</span>: <span class="token string">"on"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_cache_use_stale"</span>: <span class="token string">"error timeout http_429 http_500 http_502 http_503 http_504"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_cache_header"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"zone_size"</span>: <span class="token string">"10m"</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"nginxmanager_set_config"</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/RemoteStorage" data-section-id="tag/RemoteStorage" 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/RemoteStorage" aria-label="tag/RemoteStorage"></a>RemoteStorage</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>RemoteStorage</p>
"><p>RemoteStorage</p>
</div></div></div><div id="tag/Account-Enhancement-Limit" data-section-id="tag/Account-Enhancement-Limit" 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-Enhancement-Limit" aria-label="tag/Account-Enhancement-Limit"></a>Account Enhancement Limit</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Resellers / Account Enhancement Limit</p>
"><p>Resellers / Account Enhancement Limit</p>
</div></div></div><div id="tag/Account-Enhancement-Limit/operation/list_enhancement_limits" data-section-id="tag/Account-Enhancement-Limit/operation/list_enhancement_limits" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_enhancement_limits" id="operation/list_enhancement_limits" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Enhancement-Limit/operation/list_enhancement_limits" aria-label="tag/Account-Enhancement-Limit/operation/list_enhancement_limits"></a>Return account enhancement limits<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a reseller&#39;s account enhancement limits.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a reseller's account enhancement limits.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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 reseller&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_enhancement_limits</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_enhancement_limits</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" 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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_enhancement_limits <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:R2ab3ba:1" aria-labelledby="tab:R2ab3ba: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: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">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"limits"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enhancement_id1"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">15</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limited"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <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">"enhancement_id2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">15</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limited"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <span class="token number">15</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">"metadata"</span>: <button class="collapser" aria-label="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">"list_enhancement_limits"</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/Account-Enhancement-Limit/operation/set_enhancement_limit" data-section-id="tag/Account-Enhancement-Limit/operation/set_enhancement_limit" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_enhancement_limit" id="operation/set_enhancement_limit" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Enhancement-Limit/operation/set_enhancement_limit" aria-label="tag/Account-Enhancement-Limit/operation/set_enhancement_limit"></a>Update account enhancement limit<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets account enhancement limits for a reseller account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets account enhancement limits for a reseller 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="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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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 reseller&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller's username.</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=sample-enhancement-id</span></div><div><div html="<p>The account enhancement&#39;s identifier.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You must use an <a href="https://go.cpanel.net/account-enhancements">account enhancement</a> ID that a 3rd-party plugin defines.</li>
<li>To return a list of valid account enhancement IDs, run the WHM API 1 <code>list_account_enhancements</code> function.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account enhancement's identifier.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You must use an <a href="https://go.cpanel.net/account-enhancements">account enhancement</a> ID that a 3rd-party plugin defines.</li>
<li>To return a list of valid account enhancement IDs, run the WHM API 1 <code>list_account_enhancements</code> function.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">limit</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">limit=15</span></div><div><div html="<p>The account enhancement limit amount. This parameter is only
required if the <code>limited</code> parameter is <code>1</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account enhancement limit amount. This parameter is only
required if the <code>limited</code> parameter is <code>1</code>.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="limited" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">limited</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">limited=1</span></div><div><div html="<p>Whether the Account Enhancement assignment limit is unlimited.</p>
<ul>
<li><code>0</code> - The assignment is unlimited.</li>
<li><code>1</code> - The assignment is limited.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the Account Enhancement assignment limit is unlimited.</p>
<ul>
<li><code>0</code> - The assignment is unlimited.</li>
<li><code>1</code> - The assignment is limited.</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="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">/set_enhancement_limit</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_enhancement_limit</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" 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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_enhancement_limit <span class="token punctuation">\</span>
<span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'sample-enhancement-id'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">limited</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">limit</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:R2ad3ba:1" aria-labelledby="tab:R2ad3ba: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: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">"metadata"</span>: <button class="collapser" aria-label="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">"set_enhancement_limit"</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/Account-Limits" data-section-id="tag/Account-Limits" 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-Limits" aria-label="tag/Account-Limits"></a>Account Limits</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Resellers / Account Limits</p>
"><p>Resellers / Account Limits</p>
</div></div></div><div id="tag/Account-Limits/operation/setresellerpackagelimit" data-section-id="tag/Account-Limits/operation/setresellerpackagelimit" class="sc-dntaoT ceciOs"><div data-section-id="operation/setresellerpackagelimit" id="operation/setresellerpackagelimit" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Limits/operation/setresellerpackagelimit" aria-label="tag/Account-Limits/operation/setresellerpackagelimit"></a>Update reseller's hosting plan limits<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function limits the packages that a reseller assigns to cPanel accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function limits the packages that a reseller assigns to 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><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="allowed" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">allowed</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">allowed=1</span></div><div><div html="<p>Whether the reseller can access the package hosting plan.</p>
<ul>
<li><code>1</code> — Enable access.</li>
<li><code>0</code> — Disable access</li>
</ul>
<p><strong>Note:</strong></p>
<p>If you use this parameter, you <strong>must</strong> also include the <code>package</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the reseller can access the package hosting plan.</p>
<ul>
<li><code>1</code> — Enable access.</li>
<li><code>0</code> — Disable access</li>
</ul>
<p><strong>Note:</strong></p>
<p>If you use this parameter, you <strong>must</strong> also include the <code>package</code> parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="no_limit" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">no_limit</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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_limit=0</span></div><div><div html="<p>Whether to grant the reseller unlimited package use.</p>
<ul>
<li><code>1</code> — Grant the reseller unlimited package use.</li>
<li><code>0</code> — Use package limits.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to grant the reseller unlimited package use.</p>
<ul>
<li><code>1</code> — Grant the reseller unlimited package use.</li>
<li><code>0</code> — Use package limits.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="number" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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">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">number=5</span></div><div><div html="<p>The maximum number of accounts to which the reseller can assign the package hosting plan.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you use this parameter, you <strong>must</strong> also include the <code>package</code> parameter.</li>
<li>If you set a value for this parameter <strong>and</strong> set the <code>allowed</code> parameter to <code>0</code>, the reseller <strong>cannot</strong> use the hosting plan.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of accounts to which the reseller can assign the package hosting plan.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you use this parameter, you <strong>must</strong> also include the <code>package</code> parameter.</li>
<li>If you set a value for this parameter <strong>and</strong> set the <code>allowed</code> parameter to <code>0</code>, the reseller <strong>cannot</strong> use the hosting plan.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="package" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">package</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">package=package1</span></div><div><div html="<p>A hosting plan (package), to modify the reseller&#39;s access settings for it.</p>
<p><strong>Note:</strong></p>
<p> Use this parameter with the <code>number</code> or <code>allowed</code> parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A hosting plan (package), to modify the reseller's access settings for it.</p>
<p><strong>Note:</strong></p>
<p> Use this parameter with the <code>number</code> or <code>allowed</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><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=username</span></div><div><div html="<p>The reseller&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller'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="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">/setresellerpackagelimit</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/setresellerpackagelimit</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab5ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab5ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab5ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab5ba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab5ba:0" aria-labelledby="tab:R2ab5ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
setresellerpackagelimit <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R2ab5ba:1" aria-labelledby="tab:R2ab5ba: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:R2eb5ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb5ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb5ba:0" aria-labelledby="tab:R2eb5ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"setresellerpackagelimit"</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/Account-Limits/operation/setresellerlimits" data-section-id="tag/Account-Limits/operation/setresellerlimits" class="sc-dntaoT ceciOs"><div data-section-id="operation/setresellerlimits" id="operation/setresellerlimits" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Limits/operation/setresellerlimits" aria-label="tag/Account-Limits/operation/setresellerlimits"></a>Update reseller's bandwidth and disk quotas<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets a reseller&#39;s bandwidth and disk quotas.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets a reseller's bandwidth and disk quotas.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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_limit" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account_limit</span></td><td class="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">account_limit=10</span></div><div><div html="<p>The reseller&#39;s maximum total number of accounts.</p>
<p><strong>Important:</strong></p>
<p>The system <strong>only</strong> enforces this maximum if you set the <code>enable_account_limit</code>
value to <code>1</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller's maximum total number of accounts.</p>
<p><strong>Important:</strong></p>
<p>The system <strong>only</strong> enforces this maximum if you set the <code>enable_account_limit</code>
value to <code>1</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="bandwidth_limit" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">bandwidth_limit</span></td><td class="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"> <!-- --><<!-- -->megabytes<!-- -->><!-- --> </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">bandwidth_limit=1073741824</span></div><div><div html="<p>The reseller&#39;s total bandwidth limit.</p>
<p><strong>Important:</strong></p>
<p>The system <strong>only</strong> enforces this limit if you set the <code>enable_resource_limits</code>
value to <code>1</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller's total bandwidth limit.</p>
<p><strong>Important:</strong></p>
<p>The system <strong>only</strong> enforces this limit if you set the <code>enable_resource_limits</code>
value to <code>1</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="diskspace_limit" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">diskspace_limit</span></td><td class="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"> <!-- --><<!-- -->megabytes<!-- -->><!-- --> </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">diskspace_limit=1073741824</span></div><div><div html="<p>The reseller&#39;s total disk space usage limit.</p>
<p><strong>Important:</strong></p>
<p>The system <strong>only</strong> enforces this limit if you set the <code>enable_resource_limits</code>
value to <code>1</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller's total disk space usage limit.</p>
<p><strong>Important:</strong></p>
<p>The system <strong>only</strong> enforces this limit if you set the <code>enable_resource_limits</code>
value to <code>1</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="enable_account_limit" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enable_account_limit</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">enable_account_limit=0</span></div><div><div html="<p>Whether to limit the reseller&#39;s total number of accounts.</p>
<ul>
<li><code>1</code> — Limit.</li>
<li><code>0</code> — Do <strong>not</strong> limit.</li>
</ul>
<p><strong>Note:</strong></p>
<p>Use this parameter with the <code>account_limit</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to limit the reseller's total number of accounts.</p>
<ul>
<li><code>1</code> — Limit.</li>
<li><code>0</code> — Do <strong>not</strong> limit.</li>
</ul>
<p><strong>Note:</strong></p>
<p>Use this parameter with the <code>account_limit</code> parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="enable_overselling" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enable_overselling</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">enable_overselling=1</span></div><div><div html="<p>Whether the reseller can oversell accounts.</p>
<ul>
<li><code>1</code> — The reseller can oversell accounts.</li>
<li><code>0</code> — The reseller <strong>cannot</strong> oversell accounts.</li>
</ul>
<p><strong>Important:</strong></p>
<p>The system <strong>only</strong> enforces this limit if you set the <code>enable_resource_limits</code>
value to <code>1</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the reseller can oversell accounts.</p>
<ul>
<li><code>1</code> — The reseller can oversell accounts.</li>
<li><code>0</code> — The reseller <strong>cannot</strong> oversell accounts.</li>
</ul>
<p><strong>Important:</strong></p>
<p>The system <strong>only</strong> enforces this limit if you set the <code>enable_resource_limits</code>
value to <code>1</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="enable_overselling_bandwidth" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enable_overselling_bandwidth</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">enable_overselling_bandwidth=1</span></div><div><div html="<p>Whether the reseller can oversell bandwidth.</p>
<ul>
<li><code>1</code> — The reseller can oversell bandwidth.</li>
<li><code>0</code> — The reseller <strong>cannot</strong> oversell bandwidth.</li>
</ul>
<p><strong>Important:</strong></p>
<p>The system <strong>only</strong> enforces this limit if you set the <code>enable_resource_limits</code> and
the <code>enable_overselling</code> values to <code>1</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the reseller can oversell bandwidth.</p>
<ul>
<li><code>1</code> — The reseller can oversell bandwidth.</li>
<li><code>0</code> — The reseller <strong>cannot</strong> oversell bandwidth.</li>
</ul>
<p><strong>Important:</strong></p>
<p>The system <strong>only</strong> enforces this limit if you set the <code>enable_resource_limits</code> and
the <code>enable_overselling</code> values to <code>1</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="enable_overselling_diskspace" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enable_overselling_diskspace</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">enable_overselling_diskspace=1</span></div><div><div html="<p>Whether the reseller can oversell disk space.</p>
<ul>
<li><code>1</code> — The reseller can oversell disk space.</li>
<li><code>0</code> — The reseller <strong>cannot</strong> oversell disk space.</li>
</ul>
<p><strong>Important:</strong></p>
<p>The system <strong>only</strong> enforces this limit if you set the <code>enable_resource_limits</code>
and the <code>enable_oversellng</code> values to <code>1</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the reseller can oversell disk space.</p>
<ul>
<li><code>1</code> — The reseller can oversell disk space.</li>
<li><code>0</code> — The reseller <strong>cannot</strong> oversell disk space.</li>
</ul>
<p><strong>Important:</strong></p>
<p>The system <strong>only</strong> enforces this limit if you set the <code>enable_resource_limits</code>
and the <code>enable_oversellng</code> values to <code>1</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="enable_package_limit_numbers" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enable_package_limit_numbers</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">enable_package_limit_numbers=0</span></div><div><div html="<p>Whether to apply package limit numbers to the reseller.</p>
<ul>
<li><code>1</code> — Enable package limit numbers.</li>
<li><code>0</code> — Disable package limit numbers.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to apply package limit numbers to the reseller.</p>
<ul>
<li><code>1</code> — Enable package limit numbers.</li>
<li><code>0</code> — Disable package limit numbers.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="enable_package_limits" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enable_package_limits</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">enable_package_limits=0</span></div><div><div html="<p>Whether to apply package limits to the reseller.</p>
<ul>
<li><code>1</code> — Enable package limits.</li>
<li><code>0</code> — Disable package limits.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to apply package limits to the reseller.</p>
<ul>
<li><code>1</code> — Enable package limits.</li>
<li><code>0</code> — Disable package limits.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="enable_resource_limits" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enable_resource_limits</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">enable_resource_limits=1</span></div><div><div html="<p>Whether to limit the reseller&#39;s resources.</p>
<ul>
<li><code>1</code> — Limit resources.</li>
<li><code>0</code> — Do <strong>not</strong> limit resources.</li>
</ul>
<p><strong>Note:</strong></p>
<p>Use this parameter with the <code>bandwidthlimit</code>, <code>diskspace_limit</code>,
<code>enable_overselling</code>, <code>enable_overselling_bandwidth</code>, <code>enable_overselling_diskspace</code>,
<code>enable_overselling</code>, <code>enable_package_limits</code>, and <code>enable_package_limit_numbers</code>
parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to limit the reseller's resources.</p>
<ul>
<li><code>1</code> — Limit resources.</li>
<li><code>0</code> — Do <strong>not</strong> limit resources.</li>
</ul>
<p><strong>Note:</strong></p>
<p>Use this parameter with the <code>bandwidthlimit</code>, <code>diskspace_limit</code>,
<code>enable_overselling</code>, <code>enable_overselling_bandwidth</code>, <code>enable_overselling_diskspace</code>,
<code>enable_overselling</code>, <code>enable_package_limits</code>, and <code>enable_package_limit_numbers</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><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=username</span></div><div><div html="<p>The reseller&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller'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="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">/setresellerlimits</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/setresellerlimits</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ad5ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad5ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad5ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad5ba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad5ba:0" aria-labelledby="tab:R2ad5ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
setresellerlimits <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R2ad5ba:1" aria-labelledby="tab:R2ad5ba: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:R2ed5ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed5ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed5ba:0" aria-labelledby="tab:R2ed5ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"setresellerlimits"</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/Account-Permissions" data-section-id="tag/Account-Permissions" 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-Permissions" aria-label="tag/Account-Permissions"></a>Account Permissions</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Resellers / Account Permissions</p>
"><p>Resellers / Account Permissions</p>
</div></div></div><div id="tag/Account-Permissions/operation/setacls" data-section-id="tag/Account-Permissions/operation/setacls" class="sc-dntaoT ceciOs"><div data-section-id="operation/setacls" id="operation/setacls" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Permissions/operation/setacls" aria-label="tag/Account-Permissions/operation/setacls"></a>Create or update reseller privilege settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates or modifies an Access Control List (ACL).</p>
<p><strong>Note:</strong></p>
<p> For each <code>acl-*</code> parameter, any value adds that privilege to the ACL list and no value removes that privilege from the ACL list.</p>
<p><strong>Warning:</strong></p>
<p> We <strong>strongly</strong> recommend that WHM users create and edit ACLs and ACL privileges through WHM&#39;s <a href="https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges"><em>Edit Reseller Nameservers and Privileges</em></a> interface ( <em>WHM &gt;&gt; Home &gt;&gt; Resellers &gt;&gt; Edit Reseller Nameservers and Privileges</em> ).</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates or modifies an Access Control List (ACL).</p>
<p><strong>Note:</strong></p>
<p> For each <code>acl-*</code> parameter, any value adds that privilege to the ACL list and no value removes that privilege from the ACL list.</p>
<p><strong>Warning:</strong></p>
<p> We <strong>strongly</strong> recommend that WHM users create and edit ACLs and ACL privileges through WHM's <a href="https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges"><em>Edit Reseller Nameservers and Privileges</em></a> interface ( <em>WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges</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=""><td kind="field" title="acl-acct-summary" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-acct-summary</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-acct-summary=1</span></div><div><div html="<p>Whether to allow the reseller to view an account summary.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view an account summary.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-add-pkg" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-add-pkg</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-add-pkg=1</span></div><div><div html="<p>Whether to allow the reseller to add and remove hosting plans (packages).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to add and remove hosting plans (packages).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-add-pkg-ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-add-pkg-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">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-add-pkg-ip=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with a dedicated IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with a dedicated IP address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-add-pkg-shell" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-add-pkg-shell</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-add-pkg-shell=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with shell access.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with shell access.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-all" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-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"> <!-- -->Value<!-- -->:</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">acl-all=1</span></div><div><div html="<p>Whether to grant the reseller all ACL privileges.</p>
<p><strong>Warning:</strong></p>
<p> A value of <code>1</code> grants <code>root</code>-level privileges to the reseller.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to grant the reseller all ACL privileges.</p>
<p><strong>Warning:</strong></p>
<p> A value of <code>1</code> grants <code>root</code>-level privileges to the reseller.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-allow-addoncreate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-allow-addoncreate</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-allow-addoncreate=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with addon domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with addon domains.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-allow-parkedcreate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-allow-parkedcreate</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-allow-parkedcreate=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with parked domains (aliases).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with parked domains (aliases).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-allow-unlimited-bw-pkgs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-allow-unlimited-bw-pkgs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-allow-unlimited-bw-pkgs=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with unlimited bandwidth.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with unlimited bandwidth.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-allow-unlimited-disk-pkgs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-allow-unlimited-disk-pkgs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-allow-unlimited-disk-pkgs=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with unlimited disk space.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with unlimited disk space.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-allow-unlimited-pkgs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-allow-unlimited-pkgs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-allow-unlimited-pkgs=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with unlimited features.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with unlimited features.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-basic-system-info" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-basic-system-info</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-basic-system-info=1</span></div><div><div html="<p>Whether to allow the reseller to retrieve basic system information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to retrieve basic system information.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-basic-whm-functions" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-basic-whm-functions</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-basic-whm-functions=1</span></div><div><div html="<p>Whether to allow the reseller to access basic cPanel &amp; WHM options.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to access basic cPanel & WHM options.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-clustering" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-clustering</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-clustering=1</span></div><div><div html="<p>Whether to allow the reseller to use DNS clusters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to use DNS clusters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-cors-proxy-get" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-cors-proxy-get</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-cors-proxy-get=1</span></div><div><div html="<p>Whether to allow the reseller to perform Cross-Origin Resource Sharing (CORS) HTTP requests.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to perform Cross-Origin Resource Sharing (CORS) HTTP requests.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-cpanel-api" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-cpanel-api</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-cpanel-api=1</span></div><div><div html="<p>Whether to allow the reseller to execute cPanel API 1, cPanel API 2 and UAPI functions via WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to execute cPanel API 1, cPanel API 2 and UAPI functions via WHM.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-cpanel-integration" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-cpanel-integration</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-cpanel-integration=1</span></div><div><div html="<p>Whether to allow the reseller to manage how their server and its services connect to other servers and services.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage how their server and its services connect to other servers and services.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-create-acct" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-create-acct</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-create-acct=1</span></div><div><div html="<p>Whether to allow the reseller to create accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-create-dns" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-create-dns</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-create-dns=1</span></div><div><div html="<p>Whether to allow the reseller to add DNS zones.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to add DNS zones.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-create-user-session" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-create-user-session</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-create-user-session=1</span></div><div><div html="<p>Whether to allow the reseller to create a temporary session user for a specified service.</p>
<p><strong>Note:</strong></p>
<p> This privilege allows an API token user to bypass any restrictions that you set on the API token. For more information, read our <a href="https://go.cpanel.net/whmdocsManageasisAPITokens">Manage API Tokens</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create a temporary session user for a specified service.</p>
<p><strong>Note:</strong></p>
<p> This privilege allows an API token user to bypass any restrictions that you set on the API token. For more information, read our <a href="https://go.cpanel.net/whmdocsManageasisAPITokens">Manage API Tokens</a> documentation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-demo-setup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-demo-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">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-demo-setup=1</span></div><div><div html="<p>Whether to allow the reseller to enable demo mode for accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to enable demo mode for accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-digest-auth" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-digest-auth</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-digest-auth=1</span></div><div><div html="<p>Whether to allow the reseller to manage Digest Authentication support.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage Digest Authentication support.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-disallow-shell" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-disallow-shell</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-disallow-shell=1</span></div><div><div html="<p>Whether to allow the reseller to create accounts with shell access.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create accounts with shell access.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-edit-account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-edit-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">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-edit-account=1</span></div><div><div html="<p>Whether to allow the reseller to edit accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to edit accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-edit-dns" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-edit-dns</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-edit-dns=1</span></div><div><div html="<p>Whether to allow the reseller to edit DNS zones.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to edit DNS zones.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-edit-mx" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-edit-mx</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-edit-mx=1</span></div><div><div html="<p>Whether to allow the reseller to edit MX entries.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to edit MX entries.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-edit-pkg" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-edit-pkg</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-edit-pkg=1</span></div><div><div html="<p>Whether to allow the reseller to edit hosting plans (packages).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to edit hosting plans (packages).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-generate-email-config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-generate-email-config</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-generate-email-config=1</span></div><div><div html="<p>Whether to allow the reseller to generate a mobile configuration profile for an email account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to generate a mobile configuration profile for an email account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-kill-acct" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-kill-acct</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-kill-acct=1</span></div><div><div html="<p>Whether to allow the reseller to terminate accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to terminate accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-kill-dns" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-kill-dns</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-kill-dns=1</span></div><div><div html="<p>Whether to allow the reseller to remove DNS zones.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to remove DNS zones.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-limit-bandwidth" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-limit-bandwidth</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-limit-bandwidth=1</span></div><div><div html="<p>Whether to allow the reseller to modify bandwidth limits (quotas).</p>
<p><strong>Warning:</strong></p>
<p> If you do <strong>not</strong> use resource limits, a value of <code>1</code> allows resellers to circumvent package limits for disk space.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to modify bandwidth limits (quotas).</p>
<p><strong>Warning:</strong></p>
<p> If you do <strong>not</strong> use resource limits, a value of <code>1</code> allows resellers to circumvent package limits for disk space.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-list-accts" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-list-accts</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-list-accts=1</span></div><div><div html="<p>Whether to allow the reseller to view the list of accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view the list of accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-list-pkgs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-list-pkgs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-list-pkgs=1</span></div><div><div html="<p>Whether to allow the reseller to view existing hosting plans (packages).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view existing hosting plans (packages).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-locale-edit" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-locale-edit</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-locale-edit=1</span></div><div><div html="<p>Whether to allow the reseller to create and modify locales on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create and modify locales on the server.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-mailcheck" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-mailcheck</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-mailcheck=1</span></div><div><div html="<p>Whether to allow the reseller to troubleshoot mail delivery.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to troubleshoot mail delivery.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-manage-api-tokens" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-manage-api-tokens</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-manage-api-tokens=1</span></div><div><div html="<p>Whether to allow the reseller to manage API tokens.</p>
<p><strong>Note:</strong></p>
<p> This privilege allows an API token user to bypass any restrictions that you set on the API token. For more information, read our <a href="https://go.cpanel.net/whmdocsManageasisAPITokens">Manage API Tokens</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage API tokens.</p>
<p><strong>Note:</strong></p>
<p> This privilege allows an API token user to bypass any restrictions that you set on the API token. For more information, read our <a href="https://go.cpanel.net/whmdocsManageasisAPITokens">Manage API Tokens</a> documentation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-manage-dns-records" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-manage-dns-records</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-manage-dns-records=1</span></div><div><div html="<p>Whether to allow the reseller to manage DNS records.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage DNS records.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-manage-oidc" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-manage-oidc</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-manage-oidc=1</span></div><div><div html="<p>Whether to allow the reseller to manage external authentication for their accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage external authentication for their accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-manage-styles" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-manage-styles</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-manage-styles=1</span></div><div><div html="<p>Whether to allow the reseller to manage their server&#39;s cPanel styles.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage their server's cPanel styles.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-mysql-info" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-mysql-info</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-mysql-info=1</span></div><div><div html="<p>Whether to allow the reseller to retrieve MySQL® database and user data.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to retrieve MySQL® database and user data.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-nameserver-config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-nameserver-config</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-nameserver-config=1</span></div><div><div html="<p>Whether to allow the reseller to manage nameservers.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage nameservers.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-news" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-news</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-news=1</span></div><div><div html="<p>Whether to allow the reseller to modify the server&#39;s news.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to modify the server's news.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-park-dns" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-park-dns</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-park-dns=1</span></div><div><div html="<p>Whether to allow the reseller to park DNS zones.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to park DNS zones.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-passwd" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-passwd</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-passwd=1</span></div><div><div html="<p>Whether to allow the reseller to change passwords.</p>
<p><strong>Note:</strong></p>
<p> This privilege allows an API token user to change account passwords and log in with a new password. For more information, read our <a href="https://go.cpanel.net/whmdocsManageasisAPITokens">Manage API Tokens</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to change passwords.</p>
<p><strong>Note:</strong></p>
<p> This privilege allows an API token user to change account passwords and log in with a new password. For more information, read our <a href="https://go.cpanel.net/whmdocsManageasisAPITokens">Manage API Tokens</a> documentation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-quota" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-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"> <!-- -->Value<!-- -->:</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">acl-quota=1</span></div><div><div html="<p>Whether to allow the reseller to modify quotas.</p>
<p><strong>Warning:</strong></p>
<p> If you do <strong>not</strong> use resource limits, a value of <code>1</code> allows resellers to circumvent package limits for disk space.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to modify quotas.</p>
<p><strong>Warning:</strong></p>
<p> If you do <strong>not</strong> use resource limits, a value of <code>1</code> allows resellers to circumvent package limits for disk space.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-rearrange-accts" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-rearrange-accts</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-rearrange-accts=1</span></div><div><div html="<p>Whether to allow the reseller to rearrange accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to rearrange accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-resftp" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-resftp</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-resftp=1</span></div><div><div html="<p>Whether to allow the reseller to resync FTP passwords.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to resync FTP passwords.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-restart" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-restart</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-restart=1</span></div><div><div html="<p>Whether to allow the reseller to restart services.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to restart services.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-show-bandwidth" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-show-bandwidth</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-show-bandwidth=1</span></div><div><div html="<p>Whether to allow the reseller to view account bandwidth usage.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view account bandwidth usage.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-ssl" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-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"> <!-- -->Value<!-- -->:</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">acl-ssl=1</span></div><div><div html="<p>Whether to allow the reseller to perform SSL site management.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to perform SSL site management.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-ssl-buy" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-ssl-buy</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-ssl-buy=1</span></div><div><div html="<p>Whether to allow the reseller to purchase SSL certificates.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to purchase SSL certificates.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-ssl-gencrt" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-ssl-gencrt</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-ssl-gencrt=1</span></div><div><div html="<p>Whether to allow the reseller to generate SSL certificates.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to generate SSL certificates.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-ssl-info" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-ssl-info</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-ssl-info=1</span></div><div><div html="<p>Whether to allow the reseller to view their server&#39;s SSL information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view their server's SSL information.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-stats" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-stats</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-stats=1</span></div><div><div html="<p>Whether to allow the reseller to view server information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view server information.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-status" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-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"> <!-- -->Value<!-- -->:</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">acl-status=1</span></div><div><div html="<p>Whether to allow the reseller to view the server&#39;s status.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view the server's status.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-suspend-acct" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-suspend-acct</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-suspend-acct=1</span></div><div><div html="<p>Whether to allow the reseller to suspend or unsuspend accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to suspend or unsuspend accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-thirdparty" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-thirdparty</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-thirdparty=1</span></div><div><div html="<p>Whether to allow the reseller to manage third-party services.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage third-party services.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-track-email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-track-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"> <!-- -->Value<!-- -->:</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">acl-track-email=1</span></div><div><div html="<p>Whether to allow the reseller to view reports about email message delivery attempts from their account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view reports about email message delivery attempts from their account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-upgrade-account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-upgrade-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">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-upgrade-account=1</span></div><div><div html="<p>Whether to allow the reseller to upgrade or downgrade accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to upgrade or downgrade accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-viewglobalpackages" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-viewglobalpackages</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">acl-viewglobalpackages=1</span></div><div><div html="<p>Whether to allow the reseller to use all global packages. For more information, read our <a href="https://go.cpanel.net/resellerpackages">reseller packages</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to use all global packages. For more information, read our <a href="https://go.cpanel.net/resellerpackages">reseller packages</a> documentation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acllist" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acllist</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">acllist=my_acl_list</span></div><div><div html="<p>The ACL to assign to the reseller.</p>
<p><strong>Warning:</strong></p>
<p> Functions should <strong>either</strong> use this parameter, or a combination of the <code>acl-*</code> parameters below. <strong>Do not</strong> include both in a single function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ACL to assign to the reseller.</p>
<p><strong>Warning:</strong></p>
<p> Functions should <strong>either</strong> use this parameter, or a combination of the <code>acl-*</code> parameters below. <strong>Do not</strong> include both in a single function.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="reseller" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">reseller</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">reseller=username</span></div><div><div html="<p>The reseller&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/setacls</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/setacls</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab7ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab7ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab7ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab7ba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab7ba:0" aria-labelledby="tab:R2ab7ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty setacls <span class="token assign-left variable">reseller</span><span class="token operator">=</span><span class="token string">'username'</span> acl-acct-summary<span class="token operator">=</span><span class="token number">1</span> acl-basic-system-info<span class="token operator">=</span><span class="token number">1</span> acl-basic-whm-functions<span class="token operator">=</span><span class="token number">1</span> acl-cors-proxy-get<span class="token operator">=</span><span class="token number">1</span> acl-cpanel-api<span class="token operator">=</span><span class="token number">1</span> acl-cpanel-integration<span class="token operator">=</span><span class="token number">1</span> acl-create-user-session<span class="token operator">=</span><span class="token number">1</span> acl-digest-auth<span class="token operator">=</span><span class="token number">1</span> acl-generate-email-config<span class="token operator">=</span><span class="token number">1</span> acl-list-pkgs<span class="token operator">=</span><span class="token number">1</span> acl-manage-api-tokens<span class="token operator">=</span><span class="token number">1</span> acl-manage-dns-records<span class="token operator">=</span><span class="token number">1</span> acl-manage-oidc<span class="token operator">=</span><span class="token number">1</span> acl-manage-styles<span class="token operator">=</span><span class="token number">1</span> acl-mysql-info<span class="token operator">=</span><span class="token number">1</span> acl-ns-config<span class="token operator">=</span><span class="token number">1</span> acl-public-contact<span class="token operator">=</span><span class="token number">1</span> acl-ssl-info<span class="token operator">=</span><span class="token number">1</span> acl-track-email<span class="token operator">=</span><span class="token number">1</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab7ba:1" aria-labelledby="tab:R2ab7ba: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:R2eb7ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb7ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb7ba:0" aria-labelledby="tab:R2eb7ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acl"</span>: <button class="collapser" aria-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></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">"command"</span>: <span class="token string">"setacls"</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/Account-Permissions/operation/listacls" data-section-id="tag/Account-Permissions/operation/listacls" class="sc-dntaoT ceciOs"><div data-section-id="operation/listacls" id="operation/listacls" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Permissions/operation/listacls" aria-label="tag/Account-Permissions/operation/listacls"></a>Return all privilege lists and settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the server&#39;s
<a href="https://go.cpanel.net/GuidetoWHMPluginsAccessControlLists">Access Control Lists (ACLs)</a>
and each list&#39;s privileges.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the server's
<a href="https://go.cpanel.net/GuidetoWHMPluginsAccessControlLists">Access Control Lists (ACLs)</a>
and each list's 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/listacls</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/listacls</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ad7ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad7ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad7ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad7ba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad7ba:0" aria-labelledby="tab:R2ad7ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
listacls
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad7ba:1" aria-labelledby="tab:R2ad7ba: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:R2ed7ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed7ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed7ba:0" aria-labelledby="tab:R2ed7ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acl"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"acl1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"privileges"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acct-summary"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"add-pkg"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"add-pkg-ip"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"add-pkg-shell"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"all"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow-addoncreate"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow-emaillimits-pkgs"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow-parkedcreate"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow-shell"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow-unlimited-bw-pkgs"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow-unlimited-disk-pkgs"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow-unlimited-pkgs"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"basic-system-info"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"basic-whm-functions"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"clustering"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cors-proxy-get"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpanel-api"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpanel-integration"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create-acct"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create-dns"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create-user-session"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"demo-setup"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"digest-auth"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit-account"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit-dns"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit-mx"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit-pkg"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"frontpage"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"generate-email-config"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"kill-acct"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"kill-dns"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit-bandwidth"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"list-accts"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"list-pkgs"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale-edit"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailcheck"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"manage-api-tokens"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"manage-dns-records"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"manage-oidc"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"manage-styles"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql-info"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"news"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ns-config"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"park-dns"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd"</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">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rearrange-accts"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"resftp"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"restart"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"show-bandwidth"</span>: <span class="token number">1</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssl-buy"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssl-gencrt"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssl-info"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stats"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspend-acct"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thirdparty"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"track-email"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"upgrade-account"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"viewglobalpackages"</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></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">"command"</span>: <span class="token string">"listacls"</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/Account-Permissions/operation/saveacllist" data-section-id="tag/Account-Permissions/operation/saveacllist" class="sc-dntaoT ceciOs"><div data-section-id="operation/saveacllist" id="operation/saveacllist" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Permissions/operation/saveacllist" aria-label="tag/Account-Permissions/operation/saveacllist"></a>Create or update privilege list and settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates or modifies an Access Control List (ACL).</p>
<p><strong>Note:</strong></p>
<p> For each <code>acl-*</code> parameter, a value of <code>1</code> adds that privilege to the ACL list and a value of <code>0</code> removes that privilege from the ACL list.</p>
<p><strong>Warning:</strong></p>
<p> We <strong>strongly</strong> recommend that WHM users create and edit ACLs and ACL privileges through WHM&#39;s <a href="https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges"><em>Edit Reseller Nameservers and Privileges</em></a> interface ( <em>WHM &gt;&gt; Home &gt;&gt; Resellers &gt;&gt; Edit Reseller Nameservers and Privileges</em> ).</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates or modifies an Access Control List (ACL).</p>
<p><strong>Note:</strong></p>
<p> For each <code>acl-*</code> parameter, a value of <code>1</code> adds that privilege to the ACL list and a value of <code>0</code> removes that privilege from the ACL list.</p>
<p><strong>Warning:</strong></p>
<p> We <strong>strongly</strong> recommend that WHM users create and edit ACLs and ACL privileges through WHM's <a href="https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges"><em>Edit Reseller Nameservers and Privileges</em></a> interface ( <em>WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges</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=""><td kind="field" title="acl-acct-summary" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-acct-summary</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-acct-summary=1</span></div><div><div html="<p>Whether to allow the reseller to view an account summary.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view an account summary.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-add-pkg" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-add-pkg</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-add-pkg=1</span></div><div><div html="<p>Whether to allow the reseller to add and remove hosting plans (packages).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to add and remove hosting plans (packages).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-add-pkg-ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-add-pkg-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">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">acl-add-pkg-ip=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with a dedicated IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with a dedicated IP address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-add-pkg-shell" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-add-pkg-shell</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-add-pkg-shell=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with shell access.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with shell access.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-all" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-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">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">acl-all=1</span></div><div><div html="<p>Whether to grant the reseller all privileges.</p>
<p><strong>Warning:</strong></p>
<p> A value of <code>1</code> grants root-level privileges to the reseller.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to grant the reseller all privileges.</p>
<p><strong>Warning:</strong></p>
<p> A value of <code>1</code> grants root-level privileges to the reseller.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-allow-addoncreate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-allow-addoncreate</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-allow-addoncreate=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with addon domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with addon domains.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-allow-emaillimits-pkgs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-allow-emaillimits-pkgs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-allow-emaillimits-pkgs=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with custom email quotas.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with custom email quotas.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-allow-parkedcreate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-allow-parkedcreate</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-allow-parkedcreate=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with parked domains (aliases).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with parked domains (aliases).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-allow-shell" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-allow-shell</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-allow-shell=1</span></div><div><div html="<p>Whether to allow the reseller to create accounts with shell access.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create accounts with shell access.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-allow-unlimited-bw-pkgs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-allow-unlimited-bw-pkgs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-allow-unlimited-bw-pkgs=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with unlimited bandwidth.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with unlimited bandwidth.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-allow-unlimited-disk-pkgs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-allow-unlimited-disk-pkgs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-allow-unlimited-disk-pkgs=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with unlimited disk space.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with unlimited disk space.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-allow-unlimited-pkgs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-allow-unlimited-pkgs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-allow-unlimited-pkgs=1</span></div><div><div html="<p>Whether to allow the reseller to create packages with unlimited features.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create packages with unlimited features.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-basic-system-info" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-basic-system-info</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-basic-system-info=1</span></div><div><div html="<p>Whether to allow the reseller to retrieve basic system information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to retrieve basic system information.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-basic-whm-functions" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-basic-whm-functions</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-basic-whm-functions=1</span></div><div><div html="<p>Whether to allow the reseller to access basic cPanel &amp; WHM options.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to access basic cPanel & WHM options.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-clustering" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-clustering</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-clustering=1</span></div><div><div html="<p>Whether to allow the reseller to use DNS clusters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to use DNS clusters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-cors-proxy-get" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-cors-proxy-get</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-cors-proxy-get=1</span></div><div><div html="<p>Whether to allow the reseller to perform Cross-Origin Resource Sharing (CORS) HTTP requests.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to perform Cross-Origin Resource Sharing (CORS) HTTP requests.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-cpanel-api" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-cpanel-api</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-cpanel-api=1</span></div><div><div html="<p>Whether to allow the reseller to execute cPanel API 1, cPanel API 2 and UAPI functions via WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to execute cPanel API 1, cPanel API 2 and UAPI functions via WHM.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-cpanel-integration" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-cpanel-integration</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-cpanel-integration=1</span></div><div><div html="<p>Whether to allow the reseller to manage how their server and its services connect to other servers and services.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage how their server and its services connect to other servers and services.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-create-acct" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-create-acct</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-create-acct=1</span></div><div><div html="<p>Whether to allow the reseller to create accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-create-dns" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-create-dns</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-create-dns=1</span></div><div><div html="<p>Whether to allow the reseller to add DNS zones.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to add DNS zones.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-create-user-session" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-create-user-session</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-create-user-session=1</span></div><div><div html="<p>Whether to allow the reseller to create a temporary user session for a specified service.</p>
<p><strong>Notes:</strong></p>
<p> This privilege allows an API token user to bypass any restrictions that you set on the API token. For more information, read our <a href="https://go.cpanel.net/whmdocsManageasisAPITokens">Manage API Tokens</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create a temporary user session for a specified service.</p>
<p><strong>Notes:</strong></p>
<p> This privilege allows an API token user to bypass any restrictions that you set on the API token. For more information, read our <a href="https://go.cpanel.net/whmdocsManageasisAPITokens">Manage API Tokens</a> documentation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-demo-setup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-demo-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">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">acl-demo-setup=1</span></div><div><div html="<p>Whether to allow the reseller to enable demo mode for accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to enable demo mode for accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-digest-auth" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-digest-auth</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-digest-auth=1</span></div><div><div html="<p>Whether to allow the reseller to manage Digest Authentication support.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage Digest Authentication support.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-edit-account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-edit-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">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">acl-edit-account=1</span></div><div><div html="<p>Whether to allow the reseller to edit accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to edit accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-edit-dns" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-edit-dns</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-edit-dns=1</span></div><div><div html="<p>Whether to allow the reseller to edit DNS zones.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to edit DNS zones.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-edit-mx" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-edit-mx</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-edit-mx=1</span></div><div><div html="<p>Whether to allow the reseller to edit MX entries.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to edit MX entries.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-edit-pkg" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-edit-pkg</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-edit-pkg=1</span></div><div><div html="<p>Whether to allow the reseller to edit hosting plans (packages).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to edit hosting plans (packages).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-generate-email-config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-generate-email-config</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-generate-email-config=1</span></div><div><div html="<p>Whether to allow the reseller to generate a mobile configuration profile for an email account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to generate a mobile configuration profile for an email account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-kill-acct" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-kill-acct</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-kill-acct=1</span></div><div><div html="<p>Whether to allow the reseller to terminate accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to terminate accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-kill-dns" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-kill-dns</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-kill-dns=1</span></div><div><div html="<p>Whether to allow the reseller to remove DNS zones.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to remove DNS zones.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-limit-bandwidth" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-limit-bandwidth</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-limit-bandwidth=1</span></div><div><div html="<p>Whether to allow the reseller to modify bandwidth limits (quotas).</p>
<p><strong>Warning:</strong></p>
<p> If you do not use resource limits, a value of <code>1</code> allows resellers to circumvent package limits for disk space.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to modify bandwidth limits (quotas).</p>
<p><strong>Warning:</strong></p>
<p> If you do not use resource limits, a value of <code>1</code> allows resellers to circumvent package limits for disk space.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-list-accts" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-list-accts</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-list-accts=1</span></div><div><div html="<p>Whether to allow the reseller to view the list of accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view the list of accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-list-pkgs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-list-pkgs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-list-pkgs=1</span></div><div><div html="<p>Whether to allow the reseller to view existing hosting plans (packages).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view existing hosting plans (packages).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-locale-edit" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-locale-edit</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-locale-edit=1</span></div><div><div html="<p>Whether to allow the reseller to create and modify locales on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to create and modify locales on the server.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-mailcheck" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-mailcheck</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-mailcheck=1</span></div><div><div html="<p>Whether to allow the reseller to troubleshoot mail delivery.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to troubleshoot mail delivery.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-manage-api-tokens" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-manage-api-tokens</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-manage-api-tokens=1</span></div><div><div html="<p>Whether to allow the reseller to manage API tokens.</p>
<p><strong>Notes:</strong></p>
<p> This privilege allows an API token user to bypass any restrictions that you set on the API token. For more information, read our <a href="https://go.cpanel.net/whmdocsManageasisAPITokens">Manage API Tokens</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage API tokens.</p>
<p><strong>Notes:</strong></p>
<p> This privilege allows an API token user to bypass any restrictions that you set on the API token. For more information, read our <a href="https://go.cpanel.net/whmdocsManageasisAPITokens">Manage API Tokens</a> documentation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-manage-dns-records" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-manage-dns-records</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-manage-dns-records=1</span></div><div><div html="<p>Whether to allow the reseller to manage DNS records.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage DNS records.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-manage-oidc" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-manage-oidc</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-manage-oidc=1</span></div><div><div html="<p>Whether to allow the reseller to manage external authentication for their accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage external authentication for their accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-manage-styles" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-manage-styles</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-manage-styles=1</span></div><div><div html="<p>Whether to allow the reseller to manage their server&#39;s cPanel styles.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage their server's cPanel styles.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-mysql-info" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-mysql-info</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-mysql-info=1</span></div><div><div html="<p>Whether to allow the reseller to retrieve MySQL® database and user data.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to retrieve MySQL® database and user data.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-news" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-news</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-news=1</span></div><div><div html="<p>Whether to allow the reseller to modify the server&#39;s news.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to modify the server's news.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-ns-config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-ns-config</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-ns-config=1</span></div><div><div html="<p>Whether to allow the reseller to manage nameservers.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage nameservers.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-park-dns" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-park-dns</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-park-dns=1</span></div><div><div html="<p>Whether to allow the reseller to park DNS zones.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to park DNS zones.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-passwd" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-passwd</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-passwd=1</span></div><div><div html="<p>Whether to allow the reseller to change passwords.</p>
<p><strong>Note:</strong></p>
<p> This privilege allows an API token user to change account passwords and log in with a new password. For more information, read our <a href="https://go.cpanel.net/whmdocsManageasisAPITokens">Manage API Tokens</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to change passwords.</p>
<p><strong>Note:</strong></p>
<p> This privilege allows an API token user to change account passwords and log in with a new password. For more information, read our <a href="https://go.cpanel.net/whmdocsManageasisAPITokens">Manage API Tokens</a> documentation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-quota" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-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">acl-quota=1</span></div><div><div html="<p>Whether to allow the reseller to modify quotas.</p>
<p><strong>Warning:</strong></p>
<p> If you do not use resource limits, this privilege allows resellers to circumvent package limits for disk space.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to modify quotas.</p>
<p><strong>Warning:</strong></p>
<p> If you do not use resource limits, this privilege allows resellers to circumvent package limits for disk space.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-rearrange-accts" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-rearrange-accts</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-rearrange-accts=1</span></div><div><div html="<p>Whether to allow the reseller to rearrange accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to rearrange accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-resftp" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-resftp</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-resftp=1</span></div><div><div html="<p>Whether to allow the reseller to resync FTP passwords.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to resync FTP passwords.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-restart" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-restart</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-restart=1</span></div><div><div html="<p>Whether to allow the reseller to restart services.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to restart services.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-show-bandwidth" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-show-bandwidth</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-show-bandwidth=1</span></div><div><div html="<p>Whether to allow the reseller to view account bandwidth usage.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view account bandwidth usage.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-ssl" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-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">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">acl-ssl=1</span></div><div><div html="<p>Whether to allow the reseller to perform SSL site management.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to perform SSL site management.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-ssl-buy" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-ssl-buy</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-ssl-buy=1</span></div><div><div html="<p>Whether to allow the reseller to purchase SSL certificates.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to purchase SSL certificates.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-ssl-gencrt" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-ssl-gencrt</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-ssl-gencrt=1</span></div><div><div html="<p>Whether to allow the reseller to generate SSL certificates.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to generate SSL certificates.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-ssl-info" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-ssl-info</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-ssl-info=1</span></div><div><div html="<p>Whether to allow the reseller to view their server&#39;s SSL information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view their server's SSL information.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-stats" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-stats</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-stats=1</span></div><div><div html="<p>Whether to allow the reseller to view server information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view server information.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-status" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-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">acl-status=1</span></div><div><div html="<p>Whether to allow the reseller to view the server&#39;s status.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view the server's status.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-suspend-acct" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-suspend-acct</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-suspend-acct=1</span></div><div><div html="<p>Whether to allow the reseller to suspend or unsuspend accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to suspend or unsuspend accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-thirdparty" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-thirdparty</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-thirdparty=1</span></div><div><div html="<p>Whether to allow the reseller to manage third-party services.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to manage third-party services.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-track-email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-track-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">acl-track-email=1</span></div><div><div html="<p>Whether to allow the reseller to view reports about email message delivery attempts from their account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to view reports about email message delivery attempts from their account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-upgrade-account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-upgrade-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">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">acl-upgrade-account=1</span></div><div><div html="<p>Whether to allow the reseller to upgrade or downgrade accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to upgrade or downgrade accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="acl-viewglobalpackages" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acl-viewglobalpackages</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">acl-viewglobalpackages=1</span></div><div><div html="<p>Whether to allow the reseller to use all global packages. For more information, read our <a href="https://go.cpanel.net/GuidetoResellerAccounts#which-packages-can-resellers-view-and-assign">reseller packages</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the reseller to use all global packages. For more information, read our <a href="https://go.cpanel.net/GuidetoResellerAccounts#which-packages-can-resellers-view-and-assign">reseller packages</a> documentation.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="acllist" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">acllist</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">acllist=my_acl_list</span></div><div><div html="<p>The ACL to assign to the reseller.</p>
<p><strong>Note:</strong></p>
<p> To modify an existing ACL, set this value to that ACL&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ACL to assign to the reseller.</p>
<p><strong>Note:</strong></p>
<p> To modify an existing ACL, set this value to that ACL'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="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">/saveacllist</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/saveacllist</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2af7ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2af7ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2af7ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af7ba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2af7ba:0" aria-labelledby="tab:R2af7ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
saveacllist <span class="token punctuation">\</span>
<span class="token assign-left variable">acllist</span><span class="token operator">=</span><span class="token string">'my_acl_list'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2af7ba:1" aria-labelledby="tab:R2af7ba: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:R2ef7ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ef7ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ef7ba:0" aria-labelledby="tab:R2ef7ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"saveacllist"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"ACL List my_acl_list saved."</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/Account-Settings" data-section-id="tag/Account-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/Account-Settings" aria-label="tag/Account-Settings"></a>Account Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Resellers / Account Settings</p>
"><p>Resellers / Account Settings</p>
</div></div></div><div id="tag/Account-Settings/operation/get_public_contact" data-section-id="tag/Account-Settings/operation/get_public_contact" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_public_contact" id="operation/get_public_contact" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Settings/operation/get_public_contact" aria-label="tag/Account-Settings/operation/get_public_contact"></a>Return current user's public contact information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves an account&#39;s <a href="https://docs.cpanel.net/whm/cpanel/customization/#public-contact">public contact information</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an account's <a href="https://docs.cpanel.net/whm/cpanel/customization/#public-contact">public contact information</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_public_contact</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_public_contact</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R9939ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9939ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R9939ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R9939ba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9939ba:0" aria-labelledby="tab:R9939ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_public_contact
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9939ba:1" aria-labelledby="tab:R9939ba: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:R9p39ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p39ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p39ba:0" aria-labelledby="tab:R9p39ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"Bob's Hosting"</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://bobshosting.net">https://bobshosting.net</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_public_contact"</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/Account-Settings/operation/set_public_contact" data-section-id="tag/Account-Settings/operation/set_public_contact" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_public_contact" id="operation/set_public_contact" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Settings/operation/set_public_contact" aria-label="tag/Account-Settings/operation/set_public_contact"></a>Update current user's public contact information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets an account&#39;s public contact information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets an account's public contact 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="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=Bob's Hosting</span></div><div><div html="<p>The public contact name of the reseller. If you do not use this
parameter, the system retains the current setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The public contact name of the reseller. If you do not use this
parameter, the system retains the current setting.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">url=https://bobshosting.net</span></div><div><div html="<p>The public contact URL. If you do not use this parameter, the
system retains the current setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The public contact URL. If you do not use this parameter, the
system retains the current setting.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/set_public_contact</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_public_contact</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R9959ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9959ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R9959ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R9959ba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9959ba:0" aria-labelledby="tab:R9959ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_public_contact
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9959ba:1" aria-labelledby="tab:R9959ba: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:R9p59ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p59ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p59ba:0" aria-labelledby="tab:R9p59ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_public_contact"</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/Account-Settings/operation/acctcounts" data-section-id="tag/Account-Settings/operation/acctcounts" class="sc-dntaoT ceciOs"><div data-section-id="operation/acctcounts" id="operation/acctcounts" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Settings/operation/acctcounts" aria-label="tag/Account-Settings/operation/acctcounts"></a>Return reseller's owned accounts' information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists a reseller&#39;s total accounts, suspended accounts, and account creation limit.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a reseller's total accounts, suspended accounts, and account creation limit.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=username</span></div><div><div html="<p>A reseller&#39;s username, to query that reseller. If you do not specify a value, the function lists information for the authenticated account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A reseller's username, to query that reseller. If you do not specify a value, the function lists information for the authenticated 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/acctcounts</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/acctcounts</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R9979ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9979ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R9979ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R9979ba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9979ba:0" aria-labelledby="tab:R9979ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
acctcounts
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9979ba:1" aria-labelledby="tab:R9979ba: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:R9p79ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p79ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p79ba:0" aria-labelledby="tab:R9p79ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"reseller"</span>: <button class="collapser" aria-label="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">9</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">25</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspended"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"root"</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"acctcounts"</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/Account-Settings/operation/listresellers" data-section-id="tag/Account-Settings/operation/listresellers" class="sc-dntaoT ceciOs"><div data-section-id="operation/listresellers" id="operation/listresellers" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Settings/operation/listresellers" aria-label="tag/Account-Settings/operation/listresellers"></a>Return all resellers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the reseller accounts on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the reseller accounts on the 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/listresellers</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/listresellers</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R9999ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9999ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R9999ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R9999ba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9999ba:0" aria-labelledby="tab:R9999ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
listresellers
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9999ba:1" aria-labelledby="tab:R9999ba: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:R9p99ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p99ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p99ba:0" aria-labelledby="tab:R9p99ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"reseller"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"bob"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"listresellers"</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/Account-Settings/operation/getresellerips" data-section-id="tag/Account-Settings/operation/getresellerips" class="sc-dntaoT ceciOs"><div data-section-id="operation/getresellerips" id="operation/getresellerips" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Settings/operation/getresellerips" aria-label="tag/Account-Settings/operation/getresellerips"></a>Return reseller's available IP addresses<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists a reseller&#39;s available IP addresses.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a reseller's available IP 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="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=username</span></div><div><div html="<p>A reseller&#39;s username, to query only that reseller.</p>
<p><strong>Note:</strong></p>
<p>If you do <strong>not</strong> specify a value, the function lists available IP addresses for the <code>root</code>
user.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A reseller's username, to query only that reseller.</p>
<p><strong>Note:</strong></p>
<p>If you do <strong>not</strong> specify a value, the function lists available IP addresses for the <code>root</code>
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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/getresellerips</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/getresellerips</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b9ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b9ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b9ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b9ba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b9ba:0" aria-labelledby="tab:R99b9ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
getresellerips
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b9ba:1" aria-labelledby="tab:R99b9ba: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:R9pb9ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb9ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb9ba:0" aria-labelledby="tab:R9pb9ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <button class="collapser" aria-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.20"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"getresellerips"</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/Account-Settings/operation/resellerstats" data-section-id="tag/Account-Settings/operation/resellerstats" class="sc-dntaoT ceciOs"><div data-section-id="operation/resellerstats" id="operation/resellerstats" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Settings/operation/resellerstats" aria-label="tag/Account-Settings/operation/resellerstats"></a>Return reseller's information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists data about a reseller&#39;s accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists data about a reseller's 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=""><td kind="field" title="filter_deleted" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">filter_deleted</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">filter_deleted=0</span></div><div><div html="<p>Do not display the reseller&#39;s deleted cPanel accounts in the function&#39;s <code>acct</code> return. This parameter modifies the data output in the <code>acct</code> return.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> display.</li>
<li><code>0</code> — Display.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Do not display the reseller's deleted cPanel accounts in the function's <code>acct</code> return. This parameter modifies the data output in the <code>acct</code> return.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> display.</li>
<li><code>0</code> — Display.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="filter_suspended" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">filter_suspended</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">filter_suspended=0</span></div><div><div html="<p>Do not display the reseller&#39;s suspended cPanel accounts in the function&#39;s <code>acct</code> return. This parameter modifies the data output in the <code>acct</code> return.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> display.</li>
<li><code>0</code> — Display.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Do not display the reseller's suspended cPanel accounts in the function's <code>acct</code> return. This parameter modifies the data output in the <code>acct</code> return.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> display.</li>
<li><code>0</code> — Display.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="month" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">month</span></td><td class="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 .. 12 ]<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">month=2</span></div><div><div html="<p>The month to query, in numeric format.</p>
<p>This parameter defaults to the current month.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The month to query, in numeric format.</p>
<p>This parameter defaults to the current month.</p>
</div></div></div></td></tr><tr class=""><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=username</span></div><div><div html="<p>The reseller&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller's username.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="year" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">year</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">year=2019</span></div><div><div html="<p>The year to query, in numeric format.</p>
<p>This parameter defaults to the current year.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The year to query, in numeric format.</p>
<p>This parameter defaults to the current year.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/resellerstats</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/resellerstats</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d9ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d9ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d9ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d9ba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d9ba:0" aria-labelledby="tab:R99d9ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
resellerstats <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R99d9ba:1" aria-labelledby="tab:R99d9ba: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:R9pd9ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd9ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd9ba:0" aria-labelledby="tab:R9pd9ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"reseller"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acct"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"bandwidthlimit"</span>: <span class="token string">"500"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bandwidthused"</span>: <span class="token number">0</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">"diskquota"</span>: <span class="token string">"1100.00"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"diskused"</span>: <span class="token string">"1.57"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">"example1.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"package"</span>: <span class="token string">"default"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspended"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"example1"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bandwidthlimit"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bwoverselling"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"diskoverselling"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><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">5.69</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"month"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalbwalloc"</span>: <span class="token string">"500"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totalbwused"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"totaldiskalloc"</span>: <span class="token string">"1100"</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">"year"</span>: <span class="token number">2019</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"resellerstats"</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/Account-Settings/operation/setresellerips" data-section-id="tag/Account-Settings/operation/setresellerips" class="sc-dntaoT ceciOs"><div data-section-id="operation/setresellerips" id="operation/setresellerips" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Settings/operation/setresellerips" aria-label="tag/Account-Settings/operation/setresellerips"></a>Add IP addresses to reseller<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds IP addresses to a reseller&#39;s account.</p>
<p><strong>Note:</strong></p>
<p>To assign a main IP address to a reseller&#39;s account, call the WHM API 1 <code>setresellermainip</code> function.</p>
<p>For more information, read our <a href="https://go.cpanel.net/whmdocsManageResellersIPDelegation">Manage Reseller&#39;s IP Delegation</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds IP addresses to a reseller's account.</p>
<p><strong>Note:</strong></p>
<p>To assign a main IP address to a reseller's account, call the WHM API 1 <code>setresellermainip</code> function.</p>
<p>For more information, read our <a href="https://go.cpanel.net/whmdocsManageResellersIPDelegation">Manage Reseller's IP Delegation</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="delegate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegate</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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"> <!-- -->Value<!-- -->:</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">delegate=1</span></div><div><div html="<p>Whether to allocate the reseller a dedicated IP address.</p>
<ul>
<li><code>1</code> — Restrict the reseller&#39;s account to its dedicated IP address.</li>
<li><code>0</code> — Allow the user to dedicate any available IP address to an owned account.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allocate the reseller a dedicated IP address.</p>
<ul>
<li><code>1</code> — Restrict the reseller's account to its dedicated IP address.</li>
<li><code>0</code> — Allow the user to dedicate any available IP address to an owned account.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="ips" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ips</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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">ips=192.168.0.20</span></div><div><div html="<p>The IP addresses to allocate to the reseller&#39;s account.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you do <strong>not</strong> use this parameter, the function clears the reseller&#39;s IP address list.</li>
<li>Use a comma-separated list to allocate multiple IP addresses.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IP addresses to allocate to the reseller's account.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you do <strong>not</strong> use this parameter, the function clears the reseller's IP address list.</li>
<li>Use a comma-separated list to allocate multiple IP addresses.</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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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 reseller&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/setresellerips</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/setresellerips</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f9ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f9ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f9ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f9ba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f9ba:0" aria-labelledby="tab:R99f9ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
setresellerips <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R99f9ba:1" aria-labelledby="tab:R99f9ba: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:R9pf9ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf9ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf9ba:0" aria-labelledby="tab:R9pf9ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <button class="collapser" aria-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.20"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"setresellerips"</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/Account-Settings/operation/setresellermainip" data-section-id="tag/Account-Settings/operation/setresellermainip" class="sc-dntaoT ceciOs"><div data-section-id="operation/setresellermainip" id="operation/setresellermainip" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Settings/operation/setresellermainip" aria-label="tag/Account-Settings/operation/setresellermainip"></a>Update reseller's main IP address<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function assigns a main IP address to a reseller&#39;s account.</p>
<p><strong>Note:</strong></p>
<p> To assign additional IP addresses to a reseller&#39;s account, call the WHM API 1 <code>setresellerips</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function assigns a main IP address to a reseller's account.</p>
<p><strong>Note:</strong></p>
<p> To assign additional IP addresses to a reseller's account, call the WHM API 1 <code>setresellerips</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="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><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">ip=192.168.0.20</span></div><div><div html="<p>The IP address to assign to the reseller&#39;s account as the main shared IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IP address to assign to the reseller's account as the main shared IP address.</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 reseller&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller'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="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">/setresellermainip</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/setresellermainip</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99h9ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h9ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h9ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h9ba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h9ba:0" aria-labelledby="tab:R99h9ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
setresellermainip <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <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.20'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h9ba:1" aria-labelledby="tab:R99h9ba: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:R9ph9ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph9ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph9ba:0" aria-labelledby="tab:R9ph9ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"setresellermainip"</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/Account-Settings/operation/setresellernameservers" data-section-id="tag/Account-Settings/operation/setresellernameservers" class="sc-dntaoT ceciOs"><div data-section-id="operation/setresellernameservers" id="operation/setresellernameservers" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Settings/operation/setresellernameservers" aria-label="tag/Account-Settings/operation/setresellernameservers"></a>Update reseller's assigned nameservers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function assigns nameservers to a reseller&#39;s account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function assigns nameservers to a reseller's 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="nameservers" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nameservers</span></td><td class="sc-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">nameservers=ns1.example.com,ns2.example.com</span> -<!-- --> <!-- -->Multiple nameservers</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">nameservers=ns1.example.com</span> -<!-- --> <!-- -->A single nameserver</li></ul><div><div html="<p>A comma-separated list of the nameserver domains to assign to the reseller&#39;s account.</p>
<p><strong>Note:</strong></p>
<p>If you do <strong>not</strong> use this parameter, the function resets the reseller&#39;s nameservers
to use the server default.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of the nameserver domains to assign to the reseller's account.</p>
<p><strong>Note:</strong></p>
<p>If you do <strong>not</strong> use this parameter, the function resets the reseller's nameservers
to use the server default.</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=username</span></div><div><div html="<p>The reseller&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller'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="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">/setresellernameservers</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/setresellernameservers</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99j9ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j9ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j9ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j9ba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j9ba:0" aria-labelledby="tab:R99j9ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
setresellernameservers <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R99j9ba:1" aria-labelledby="tab:R99j9ba: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:R9pj9ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj9ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj9ba:0" aria-labelledby="tab:R9pj9ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"setresellernameservers"</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/Reseller-Account-Management" data-section-id="tag/Reseller-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/Reseller-Account-Management" aria-label="tag/Reseller-Account-Management"></a>Reseller Account Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Resellers / Account Management</p>
"><p>Resellers / Account Management</p>
</div></div></div><div id="tag/Reseller-Account-Management/operation/setupreseller" data-section-id="tag/Reseller-Account-Management/operation/setupreseller" class="sc-dntaoT ceciOs"><div data-section-id="operation/setupreseller" id="operation/setupreseller" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Reseller-Account-Management/operation/setupreseller" aria-label="tag/Reseller-Account-Management/operation/setupreseller"></a>Enable cPanel account's reseller status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function grants reseller status to an account.</p>
<p><strong>Note:</strong></p>
<p>This function grants reseller status to an <strong>existing</strong> account. You <strong>cannot</strong> create a new account with this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function grants reseller status to an account.</p>
<p><strong>Note:</strong></p>
<p>This function grants reseller status to an <strong>existing</strong> account. You <strong>cannot</strong> create a new account with this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="makeowner" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">makeowner</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">makeowner=0</span></div><div><div html="<p>Whether to set the account to own itself.</p>
<ul>
<li><code>1</code> — Make the account own itself.</li>
<li><code>0</code> — Keep the account&#39;s current owner.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to set the account to own itself.</p>
<ul>
<li><code>1</code> — Make the account own itself.</li>
<li><code>0</code> — Keep the account's current owner.</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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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 account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 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="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">/setupreseller</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/setupreseller</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kjbba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kjbba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kjbba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjbba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kjbba:0" aria-labelledby="tab:R4kjbba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
setupreseller <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R4kjbba:1" aria-labelledby="tab:R4kjbba: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:R4sjbba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sjbba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sjbba:0" aria-labelledby="tab:R4sjbba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"setupreseller"</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/Reseller-Account-Management/operation/suspendreseller" data-section-id="tag/Reseller-Account-Management/operation/suspendreseller" class="sc-dntaoT ceciOs"><div data-section-id="operation/suspendreseller" id="operation/suspendreseller" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Reseller-Account-Management/operation/suspendreseller" aria-label="tag/Reseller-Account-Management/operation/suspendreseller"></a>Suspend reseller<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function suspends a reseller account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function suspends a reseller 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="disallow" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">disallow</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">disallow=0</span></div><div><div html="<p>Whether to allow only the <code>root</code> user to unsuspend the account.</p>
<ul>
<li><code>1</code> — <strong>Only</strong> the <code>root</code> user can unsuspend the account.</li>
<li><code>0</code> — The <code>root</code> user or the account&#39;s owner can unsuspend the account.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow only the <code>root</code> user to unsuspend the account.</p>
<ul>
<li><code>1</code> — <strong>Only</strong> the <code>root</code> user can unsuspend the account.</li>
<li><code>0</code> — The <code>root</code> user or the account's owner can unsuspend the account.</li>
</ul>
</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=Nonpayment</span></div><div><div html="<p>The reason for the reseller&#39;s suspension.</p>
<p><strong>Note:</strong></p>
<p> We <strong>strongly</strong> recommend that you <strong>always</strong> include a reason for suspension.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reason for the reseller's suspension.</p>
<p><strong>Note:</strong></p>
<p> We <strong>strongly</strong> recommend that you <strong>always</strong> include a reason for suspension.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="reseller-only" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">reseller-only</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">reseller-only=0</span></div><div><div html="<p>Whether to suspend only the reseller account.</p>
<ul>
<li><code>1</code> — The function <strong>only</strong> suspends the reseller account. The function will <strong>not</strong> suspend the accounts that the reseller account owns.</li>
<li><code>0</code> — The function suspends the reseller account <strong>and</strong> the accounts that it owns.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to suspend only the reseller account.</p>
<ul>
<li><code>1</code> — The function <strong>only</strong> suspends the reseller account. The function will <strong>not</strong> suspend the accounts that the reseller account owns.</li>
<li><code>0</code> — The function suspends the reseller account <strong>and</strong> the accounts that it owns.</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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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 reseller&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller'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="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">/suspendreseller</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/suspendreseller</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4klbba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4klbba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4klbba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4klbba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4klbba:0" aria-labelledby="tab:R4klbba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
suspendreseller <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R4klbba:1" aria-labelledby="tab:R4klbba: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:R4slbba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4slbba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4slbba:0" aria-labelledby="tab:R4slbba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"suspendreseller"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"raw"</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">"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/Reseller-Account-Management/operation/unsetupreseller" data-section-id="tag/Reseller-Account-Management/operation/unsetupreseller" class="sc-dntaoT ceciOs"><div data-section-id="operation/unsetupreseller" id="operation/unsetupreseller" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Reseller-Account-Management/operation/unsetupreseller" aria-label="tag/Reseller-Account-Management/operation/unsetupreseller"></a>Disables cPanel account's reseller status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function revokes reseller status from an account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function revokes reseller status from 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="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=username</span></div><div><div html="<p>The reseller account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller 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="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">/unsetupreseller</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/unsetupreseller</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4knbba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4knbba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4knbba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knbba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4knbba:0" aria-labelledby="tab:R4knbba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
unsetupreseller <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R4knbba:1" aria-labelledby="tab:R4knbba: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:R4snbba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4snbba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4snbba:0" aria-labelledby="tab:R4snbba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"unsetupreseller"</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/Reseller-Account-Management/operation/terminatereseller" data-section-id="tag/Reseller-Account-Management/operation/terminatereseller" class="sc-dntaoT ceciOs"><div data-section-id="operation/terminatereseller" id="operation/terminatereseller" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Reseller-Account-Management/operation/terminatereseller" aria-label="tag/Reseller-Account-Management/operation/terminatereseller"></a>Delete reseller and reseller's cPanel accounts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deletes a reseller and <strong>all</strong> of the reseller&#39;s cPanel accounts.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>You <strong>cannot</strong> recover deleted accounts. <strong>Use this function with extreme caution.</strong></li>
<li>This function deletes the reseller account and <strong>all</strong> of the accounts that the reseller
owns.</li>
<li>To remove reseller privileges from an account but <strong>not</strong> delete the reseller&#39;s account
or any accounts that the reseller owns, use the WHM API 1 <code>unsetupreseller</code> function.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a reseller and <strong>all</strong> of the reseller's cPanel accounts.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>You <strong>cannot</strong> recover deleted accounts. <strong>Use this function with extreme caution.</strong></li>
<li>This function deletes the reseller account and <strong>all</strong> of the accounts that the reseller
owns.</li>
<li>To remove reseller privileges from an account but <strong>not</strong> delete the reseller's account
or any accounts that the reseller owns, use the WHM API 1 <code>unsetupreseller</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="terminatereseller" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">terminatereseller</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">terminatereseller=1</span></div><div><div html="<p>Whether to terminate the reseller&#39;s main account.</p>
<ul>
<li><code>1</code> — Terminate.</li>
<li><code>0</code> — Do <strong>not</strong> terminate.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to terminate the reseller's main account.</p>
<ul>
<li><code>1</code> — Terminate.</li>
<li><code>0</code> — Do <strong>not</strong> terminate.</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"> <!-- --><<!-- -->username<!-- -->><!-- --> </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 reseller account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/terminatereseller</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/terminatereseller</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kpbba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kpbba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kpbba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kpbba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kpbba:0" aria-labelledby="tab:R4kpbba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
terminatereseller <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">terminatereseller</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:R4kpbba:1" aria-labelledby="tab:R4kpbba: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:R4spbba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4spbba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4spbba:0" aria-labelledby="tab:R4spbba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acct"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"raw"</span>: <span class="token string">"Running pre removal script (/usr/local/cpanel/scripts/prekillacct)......DoneCollecting\nDomain Name and IP...User: example Domain: example.com\n...DoneLocking account and setting shell to nologin...Locking\npassword for user example. passwd: Success ...DoneKilling\nall processes owned by user......DoneRemoving\nSessions.........DoneRemoving Suspended Info.........DoneCleaning\nVirtfs.........DoneRemoving Web Logs......DoneRemoving\nBandwidth Files......DoneRemoving Email Sending\nLimits Cache......DoneRemoving DKIM keys......DoneRemoving\nCrontab......DoneRemoving HTTP Virtual Hosts...Removed\nthe following non-SSL virtual hosts: example.com\nRemoved the following SSL virtual hosts: ...DoneRemoving\nftp Virtual Hosts......Done Removing user''''s\nweb content directory symlinks......DoneRemoving\nMySQL databases and users......DoneRemoving PostgreSQL\ndatabases and users......DoneRemoving User & Group.......Success...Done\nRemoving DNS Entries...example.com => deleted\nfrom hostname. ...Done Removing Email Setup...Removing\n/etc/valiases/example.com ...Done Removing mailman\nlists......Done Updating Databases......Done Removing\nbandwidth limits......Done Removing Counter Data......Done\nAdding IP back to the IP address pool...System\nhas 3 free ips. ...Done Removing user''''s cPanel\nDatabases & Updating......Done Reloading Services......Done\nRemoving mail and service configs... ...Done Removing\nLogaholic Webstats...Id: TQ:TaskQueue:129 ...Done\nSending Contacts......Done Updating internal databases...Updating\nftp passwords for example Purging ftp user example\nFtp password files updated. Ftp vhost passwords\nsynced ...Done Running post removal scripts (/usr/local/cpanel/scripts/legacypostkillacct,\n/usr/local/cpanel/scripts/postkillacct)......Done\nAccount Removal Complete!!!...example account\nremoved...Done\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">"reason"</span>: <span class="token string">"username account removed"</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">"user"</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">"metadata"</span>: <button class="collapser" aria-label="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">"terminatereseller"</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/Reseller-Account-Management/operation/unsuspendreseller" data-section-id="tag/Reseller-Account-Management/operation/unsuspendreseller" class="sc-dntaoT ceciOs"><div data-section-id="operation/unsuspendreseller" id="operation/unsuspendreseller" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Reseller-Account-Management/operation/unsuspendreseller" aria-label="tag/Reseller-Account-Management/operation/unsuspendreseller"></a>Unsuspend reseller<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function unsuspends a reseller account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function unsuspends a reseller 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="reseller-only" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">reseller-only</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">reseller-only=0</span></div><div><div html="<p>Whether to unsuspend only the reseller account.</p>
<ul>
<li><code>1</code> — The function <strong>only</strong> unsuspends the reseller account. The function will <strong>not</strong> unsuspend the accounts that the reseller account owns.</li>
<li><code>0</code> — The function unsuspends the reseller account <strong>and</strong> the accounts that it owns.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to unsuspend only the reseller account.</p>
<ul>
<li><code>1</code> — The function <strong>only</strong> unsuspends the reseller account. The function will <strong>not</strong> unsuspend the accounts that the reseller account owns.</li>
<li><code>0</code> — The function unsuspends the reseller account <strong>and</strong> the accounts that it owns.</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=username</span></div><div><div html="<p>The reseller&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reseller'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="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">/unsuspendreseller</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/unsuspendreseller</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4krbba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4krbba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4krbba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4krbba:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4krbba:0" aria-labelledby="tab:R4krbba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
unsuspendreseller <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R4krbba:1" aria-labelledby="tab:R4krbba: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:R4srbba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4srbba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4srbba:0" aria-labelledby="tab:R4srbba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"unsuspendreseller"</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/WHM-Access" data-section-id="tag/WHM-Access" 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/WHM-Access" aria-label="tag/WHM-Access"></a>WHM Access</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Security / WHM Access</p>
"><p>Security / WHM Access</p>
</div></div></div><div id="tag/WHM-Access/operation/restrict_whm_root_access" data-section-id="tag/WHM-Access/operation/restrict_whm_root_access" class="sc-dntaoT ceciOs"><div data-section-id="operation/restrict_whm_root_access" id="operation/restrict_whm_root_access" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WHM-Access/operation/restrict_whm_root_access" aria-label="tag/WHM-Access/operation/restrict_whm_root_access"></a>Restrict Access to WHM by CIDR list.<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function restricts root login to cPanel &amp; WHM based on a list of CIDR addresses.</p>
<p><strong>Note:</strong></p>
<p>This API manipulates <code>/var/cpanel/authorized_whm_root_ips</code>. We HIGHLY recommend
you not modify this file directly. Improper formatting of the file can lead to loss of all
access to cPanel &amp; WHM using the root password.</p>
<p>Use of this API replaces any previous restrictions so be sure to include previous CIDR patterns
when adding new ones.</p>
<p>As this API only restricts logins, please be aware that existing root logins are not terminated
when these restrictions are asserted.</p>
<p>This API DOES NOT restrict root resellers.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restricts root login to cPanel & WHM based on a list of CIDR addresses.</p>
<p><strong>Note:</strong></p>
<p>This API manipulates <code>/var/cpanel/authorized_whm_root_ips</code>. We HIGHLY recommend
you not modify this file directly. Improper formatting of the file can lead to loss of all
access to cPanel & WHM using the root password.</p>
<p>Use of this API replaces any previous restrictions so be sure to include previous CIDR patterns
when adding new ones.</p>
<p>As this API only restricts logins, please be aware that existing root logins are not terminated
when these restrictions are asserted.</p>
<p>This API DOES NOT restrict root resellers.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="cidr" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cidr</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->cidr<!-- -->><!-- --> </span></div> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cidr=10.2.0.0/16&cidr=10.6.5.0/24&cidr=10.1.6.7</span> -<!-- --> <!-- -->Multiple CIDR Addresses.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cidr=10.2.0.0/16</span> -<!-- --> <!-- -->A single CIDR Address</li></ul><div><div html="<p>The IPs you wish to restrict in CIDR format.</p>
<p><strong>Note:</strong></p>
<p>You can pass this parameter multiple times.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPs you wish to restrict in CIDR format.</p>
<p><strong>Note:</strong></p>
<p>You can 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/restrict_whm_root_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restrict_whm_root_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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restrict_whm_root_access <span class="token punctuation">\</span>
<span class="token assign-left variable">cidr</span><span class="token operator">=</span><span class="token number">10.2</span>.0.0/16 <span class="token punctuation">\</span>
<span class="token assign-left variable">cidr</span><span class="token operator">=</span><span class="token number">10.6</span>.5.0/24 <span class="token punctuation">\</span>
<span class="token assign-left variable">cidr</span><span class="token operator">=</span><span class="token number">10.1</span>.6.7
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riirbq:1" aria-labelledby="tab:Riirbq: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: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">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cidr"</span>: <button class="collapser" aria-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.2.0.0/16"</span>,</div></li><li><div class="hoverable "><span class="token string">"10.6.5.0/24"</span>,</div></li><li><div class="hoverable "><span class="token string">"10.1.6.7"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"restrict_whm_root_access"</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/WHM-Access/operation/allow_all_whm_root_access" data-section-id="tag/WHM-Access/operation/allow_all_whm_root_access" class="sc-dntaoT ceciOs"><div data-section-id="operation/allow_all_whm_root_access" id="operation/allow_all_whm_root_access" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WHM-Access/operation/allow_all_whm_root_access" aria-label="tag/WHM-Access/operation/allow_all_whm_root_access"></a>Clear all CIDR restrictions to login to cPanel & WHM with the root password.<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes all restrictions to root login to cPanel &amp; WHM login based on IP.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes all restrictions to root login to cPanel & WHM login based on IP.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/allow_all_whm_root_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/allow_all_whm_root_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: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></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">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
allow_all_whm_root_access
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijbbq:1" aria-labelledby="tab:Rijbbq: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: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">"metadata"</span>: <button class="collapser" aria-label="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">"allow_all_whm_root_access"</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/Configuration-Clusters" data-section-id="tag/Configuration-Clusters" 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/Configuration-Clusters" aria-label="tag/Configuration-Clusters"></a>Configuration Clusters</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Server Administration / Configuration Clusters</p>
"><p>Server Administration / Configuration Clusters</p>
</div></div></div><div id="tag/Configuration-Clusters/operation/delete_configclusterserver" data-section-id="tag/Configuration-Clusters/operation/delete_configclusterserver" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_configclusterserver" id="operation/delete_configclusterserver" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Configuration-Clusters/operation/delete_configclusterserver" aria-label="tag/Configuration-Clusters/operation/delete_configclusterserver"></a>Delete server from configuration cluster<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes a server from a configuration cluster. The function&#39;s return
data appears in the <code>metadata</code> section of its output.</p>
<p><strong>Important:</strong></p>
<p>If you log in to a configuration cluster server that is <strong>not</strong> the parent server,
<strong>nothing</strong> will indicate that the server is part of a configuration cluster. You can
<strong>only</strong> view and modify this information from the parent server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a server from a configuration cluster. The function's return
data appears in the <code>metadata</code> section of its output.</p>
<p><strong>Important:</strong></p>
<p>If you log in to a configuration cluster server that is <strong>not</strong> the parent server,
<strong>nothing</strong> will indicate that the server is part of a configuration cluster. You can
<strong>only</strong> view and modify this information from the parent 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="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.com</span></div><div><div html="<p>The hostname or IP address of a remote configuration cluster server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hostname or IP address of a remote configuration cluster 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="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">/delete_configclusterserver</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/delete_configclusterserver</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R9963ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9963ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R9963ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R9963ca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9963ca:0" aria-labelledby="tab:R9963ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
delete_configclusterserver <span class="token punctuation">\</span>
<span class="token assign-left variable">name</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:R9963ca:1" aria-labelledby="tab:R9963ca: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:R9p63ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p63ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p63ca:0" aria-labelledby="tab:R9p63ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"delete_configclusterserver"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"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/Configuration-Clusters/operation/add_configclusterserver" data-section-id="tag/Configuration-Clusters/operation/add_configclusterserver" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_configclusterserver" id="operation/add_configclusterserver" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Configuration-Clusters/operation/add_configclusterserver" aria-label="tag/Configuration-Clusters/operation/add_configclusterserver"></a>Add configuration cluster server<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds a server to a configuration cluster. The function&#39;s return data appears in
the <code>metadata</code> section of its output.</p>
<p>We recommend that you run this function as a <code>POST</code> request with SSL enabled:</p>
<ul>
<li>The length of the remote access key may cause problems if you run the function with the <code>GET</code>
method (for example, a URL in your browser).</li>
<li>You risk security problems if you enter a remote access key through the <code>GET</code> method.</li>
</ul>
<p><strong>Important:</strong></p>
<ul>
<li>Run this function as a <code>root</code>-level user on the server that you wish to use as the parent server.</li>
<li>If you log in to a configuration cluster server that is <strong>not</strong> the parent server, <strong>nothing</strong>
will indicate that the server is part of a configuration cluster. You can <strong>only</strong> view and modify
this information from the parent server.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds a server to a configuration cluster. The function's return data appears in
the <code>metadata</code> section of its output.</p>
<p>We recommend that you run this function as a <code>POST</code> request with SSL enabled:</p>
<ul>
<li>The length of the remote access key may cause problems if you run the function with the <code>GET</code>
method (for example, a URL in your browser).</li>
<li>You risk security problems if you enter a remote access key through the <code>GET</code> method.</li>
</ul>
<p><strong>Important:</strong></p>
<ul>
<li>Run this function as a <code>root</code>-level user on the server that you wish to use as the parent server.</li>
<li>If you log in to a configuration cluster server that is <strong>not</strong> the parent server, <strong>nothing</strong>
will indicate that the server is part of a configuration cluster. You can <strong>only</strong> view and modify
this information from the parent 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="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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0</span></div><div><div html="<p>A truncated version of the server&#39;s remote access key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A truncated version of the server's remote access key.</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=example.com</span></div><div><div html="<p>The remote configuration cluster server&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote configuration cluster server'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=root</span></div><div><div html="<p>The username for the server&#39;s <code>root</code>-level account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username for the server's <code>root</code>-level 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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/add_configclusterserver</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/add_configclusterserver</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99a3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99a3ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99a3ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99a3ca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99a3ca:0" aria-labelledby="tab:R99a3ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
add_configclusterserver <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'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">'root'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">key</span><span class="token operator">=</span><span class="token string">'d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99a3ca:1" aria-labelledby="tab:R99a3ca: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:R9pa3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pa3ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pa3ca:0" aria-labelledby="tab:R9pa3ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"add_configclusterserver"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"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">"signature"</span>: <span class="token string">"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"root"</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/Configuration-Clusters/operation/list_configclusterservers" data-section-id="tag/Configuration-Clusters/operation/list_configclusterservers" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_configclusterservers" id="operation/list_configclusterservers" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Configuration-Clusters/operation/list_configclusterservers" aria-label="tag/Configuration-Clusters/operation/list_configclusterservers"></a>Return all configuration cluster servers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the servers in the server&#39;s configuration cluster.</p>
<p><strong>Warning</strong>:</p>
<ul>
<li><p>WHM&#39;s Remote Access Key feature is deprecated. We <strong>strongly</strong> recommend that you use API tokens instead.</p>
</li>
<li><p>If you log in to a configuration cluster server that is <strong>not</strong> the parent server, <strong>nothing</strong> will indicate that the server is part of a configuration cluster. You can only view and modify this information from the parent server.</p>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the servers in the server's configuration cluster.</p>
<p><strong>Warning</strong>:</p>
<ul>
<li><p>WHM's Remote Access Key feature is deprecated. We <strong>strongly</strong> recommend that you use API tokens instead.</p>
</li>
<li><p>If you log in to a configuration cluster server that is <strong>not</strong> the parent server, <strong>nothing</strong> will indicate that the server is part of a configuration cluster. You can only view and modify this information from the parent server.</p>
</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><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>Configuration cluster signatures and users for each server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Configuration cluster signatures and users for each server.</p>
</div></div></div></td></tr><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">/list_configclusterservers</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_configclusterservers</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99e3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99e3ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99e3ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99e3ca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99e3ca:0" aria-labelledby="tab:R99e3ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_configclusterservers
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99e3ca:1" aria-labelledby="tab:R99e3ca: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:R9pe3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pe3ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pe3ca:0" aria-labelledby="tab:R9pe3ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"signature"</span>: <span class="token string">"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"root"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"example2.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">"signature"</span>: <span class="token string">"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"root"</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"list_configclusterservers"</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/Configuration-Clusters/operation/update_configclusterserver" data-section-id="tag/Configuration-Clusters/operation/update_configclusterserver" class="sc-dntaoT ceciOs"><div data-section-id="operation/update_configclusterserver" id="operation/update_configclusterserver" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Configuration-Clusters/operation/update_configclusterserver" aria-label="tag/Configuration-Clusters/operation/update_configclusterserver"></a>Update configuration cluster server credentials<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function updates the username or remote access key for a cluster server.</p>
<p><strong>Important:</strong></p>
<ul>
<li><p>If you log in to a configuration cluster server that is <em>not</em> the parent server, <em>nothing</em> will indicate that the server is part of a configuration cluster. You can <em>only</em> view and modify this information from the master server.</p>
</li>
<li><p>We recommend that you run this function as a <code>POST</code> request with SSL enabled:</p>
<ul>
<li>The length of the remote access key may cause problems if you run the function with the <code>GET</code> method (for example, a URL in your browser).</li>
<li>You risk security problems if you enter a remote access key through the <code>GET</code> method.</li>
</ul>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates the username or remote access key for a cluster server.</p>
<p><strong>Important:</strong></p>
<ul>
<li><p>If you log in to a configuration cluster server that is <em>not</em> the parent server, <em>nothing</em> will indicate that the server is part of a configuration cluster. You can <em>only</em> view and modify this information from the master server.</p>
</li>
<li><p>We recommend that you run this function as a <code>POST</code> request with SSL enabled:</p>
<ul>
<li>The length of the remote access key may cause problems if you run the function with the <code>GET</code> method (for example, a URL in your browser).</li>
<li>You risk security problems if you enter a remote access key through the <code>GET</code> method.</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="key" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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=d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0</span></div><div><div html="<p>The new <a href="https://docs.cpanel.net/whm/clusters/remote-access-key/">remote access key</a>. If you do <strong>not</strong> specify a value, the function does not update the remote access key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new <a href="https://docs.cpanel.net/whm/clusters/remote-access-key/">remote access key</a>. If you do <strong>not</strong> specify a value, the function does not update the remote access key.</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=example.com</span></div><div><div html="<p>The remote configuration cluster server&#39;s name or IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote configuration cluster server's name or IP address.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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=root</span></div><div><div html="<p>The server&#39;s <code>root</code>-level account username. If you do not specify a value, the function does not update the username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server's <code>root</code>-level account username. If you do not specify a value, the function does not update 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="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">/update_configclusterserver</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/update_configclusterserver</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99i3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99i3ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99i3ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99i3ca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99i3ca:0" aria-labelledby="tab:R99i3ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
update_configclusterserver <span class="token punctuation">\</span>
<span class="token assign-left variable">name</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:R99i3ca:1" aria-labelledby="tab:R99i3ca: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:R9pi3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pi3ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pi3ca:0" aria-labelledby="tab:R9pi3ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"update_configclusterserver"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"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">"signature"</span>: <span class="token string">"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"root"</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/Configuration-Clusters/operation/restore_config_from_file" data-section-id="tag/Configuration-Clusters/operation/restore_config_from_file" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_config_from_file" id="operation/restore_config_from_file" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Configuration-Clusters/operation/restore_config_from_file" aria-label="tag/Configuration-Clusters/operation/restore_config_from_file"></a>Update configuration file from backup<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function restores a configuration backup from a file. If the backup file does <strong>not</strong> contain any changes, the system does <strong>not</strong> write to the configuration file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores a configuration backup from a file. If the backup file does <strong>not</strong> contain any changes, the system does <strong>not</strong> write to the configuration 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="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">module=Main</span></div><div><div html="<p>The configuration module&#39;s name.</p>
<p><strong>Important:</strong></p>
<p>This parameter is case-sensitive. You <strong>must</strong> enter the parameter in the correct case format; otherwise, the function will fail.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The configuration module's name.</p>
<p><strong>Important:</strong></p>
<p>This parameter is case-sensitive. You <strong>must</strong> enter the parameter in the correct case format; otherwise, the function will fail.</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=/var/cpanel/cpanel.config</span></div><div><div html="<p>The absolute path to configuration file.</p>
<p><strong>Note:</strong>
If this parameter contains JSON or equals-sign key and value pairs, they <strong>must</strong> appear in new lines.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute path to configuration file.</p>
<p><strong>Note:</strong>
If this parameter contains JSON or equals-sign key and value pairs, they <strong>must</strong> appear in new lines.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/restore_config_from_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_config_from_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:R99m3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99m3ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99m3ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99m3ca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99m3ca:0" aria-labelledby="tab:R99m3ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restore_config_from_file <span class="token punctuation">\</span>
<span class="token assign-left variable">module</span><span class="token operator">=</span><span class="token string">'Main'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">path</span><span class="token operator">=</span><span class="token string">'/var/cpanel/cpanel.config'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99m3ca:1" aria-labelledby="tab:R99m3ca: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:R9pm3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pm3ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pm3ca:0" aria-labelledby="tab:R9pm3ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"restore_config_from_file"</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/Configuration-Clusters/operation/restore_config_from_upload" data-section-id="tag/Configuration-Clusters/operation/restore_config_from_upload" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_config_from_upload" id="operation/restore_config_from_upload" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Configuration-Clusters/operation/restore_config_from_upload" aria-label="tag/Configuration-Clusters/operation/restore_config_from_upload"></a>Update configuration file from backup via POST<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function restores a configuration backup file via HTTP POST
method. If the backup file does <strong>not</strong> contain any changes, the system does <strong>not</strong> write to the configuration file.</p>
<p><strong>Note:</strong></p>
<p>The format for this command line example differs from our standard format because the function <strong>only</strong> accepts an HTTP POST request. For more information about how to call this request method, read <a href="https://go.cpanel.net/Mozilla-POST-documentation">Mozilla&#39;s POST documentation</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores a configuration backup file via HTTP POST
method. If the backup file does <strong>not</strong> contain any changes, the system does <strong>not</strong> write to the configuration file.</p>
<p><strong>Note:</strong></p>
<p>The format for this command line example differs from our standard format because the function <strong>only</strong> accepts an HTTP POST request. For more information about how to call this request method, read <a href="https://go.cpanel.net/Mozilla-POST-documentation">Mozilla's POST 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><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">multipart/form-data</span></h5><div html="" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"></div><table class="sc-dprtRQ hNmabw"><tbody><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><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div html="<p>The configuration file data, in <code>multipart/form-data</code> format.</p>
<p><strong>Note:</strong></p>
<p>When you call this function on the command line, you <strong>must</strong> provide the configuration file&#39;s filepath. For example, you would use the &#39;file=@/var/cpanel/cpanel.config&#39; parameter structure to call this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The configuration file data, in <code>multipart/form-data</code> format.</p>
<p><strong>Note:</strong></p>
<p>When you call this function on the command line, you <strong>must</strong> provide the configuration file's filepath. For example, you would use the 'file=@/var/cpanel/cpanel.config' parameter structure to call this function.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"Basic"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Main"</span> </div> <div><div html="<p>The configuration module&#39;s name.</p>
<ul>
<li><code>Basic</code> — The <a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup">Basic WebHost Manager Setup</a> configuration.</li>
<li><code>Main</code> — The <a href="https://go.cpanel.net/whmdocsTweakSettings">Tweak Settings</a> configuration.</li>
</ul>
<p><strong>Important:</strong></p>
<p>This parameter is case-sensitive. You <strong>must</strong> enter the parameter in the correct case format; otherwise, the function will fail.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The configuration module's name.</p>
<ul>
<li><code>Basic</code> — The <a href="https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup">Basic WebHost Manager Setup</a> configuration.</li>
<li><code>Main</code> — The <a href="https://go.cpanel.net/whmdocsTweakSettings">Tweak Settings</a> configuration.</li>
</ul>
<p><strong>Important:</strong></p>
<p>This parameter is case-sensitive. You <strong>must</strong> enter the parameter in the correct case format; otherwise, the function will fail.</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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/restore_config_from_upload</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restore_config_from_upload</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99q3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99q3ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99q3ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99q3ca: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:R99q3ca:0" aria-labelledby="tab:R99q3ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <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>
restore_config_from_upload
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99q3ca:1" aria-labelledby="tab:R99q3ca: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:R9pq3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pq3ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pq3ca:0" aria-labelledby="tab:R9pq3ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"restore_config_from_upload"</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/Configurations" data-section-id="tag/Configurations" 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/Configurations" aria-label="tag/Configurations"></a>Configurations</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Server Administration / Configurations</p>
"><p>Server Administration / Configurations</p>
</div></div></div><div id="tag/Configurations/operation/set_tweaksetting" data-section-id="tag/Configurations/operation/set_tweaksetting" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_tweaksetting" id="operation/set_tweaksetting" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Configurations/operation/set_tweaksetting" aria-label="tag/Configurations/operation/set_tweaksetting"></a>Update Tweak Settings option<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets an option&#39;s value in WHM&#39;s
<a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/"><em>Tweak Settings</em></a>
interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>). The
system stores the keys and values that this function updates in
the
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/the-cpanel-config-file/"><code>/var/cpanel/cpanel.config</code></a>
file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets an option's value in WHM's
<a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/"><em>Tweak Settings</em></a>
interface (<em>WHM >> Home >> Server Configuration >> Tweak Settings</em>). The
system stores the keys and values that this function updates in
the
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/the-cpanel-config-file/"><code>/var/cpanel/cpanel.config</code></a>
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="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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=proxysubdomains</span></div><div><div html="<p>The <code>cpanel.config</code> setting name that corresponds to the desired
setting in WHM&#39;s
<a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/"><em>Tweak Settings</em></a>
interface (<em>WHM &gt;&gt;Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <code>cpanel.config</code> setting name that corresponds to the desired
setting in WHM's
<a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/"><em>Tweak Settings</em></a>
interface (<em>WHM >>Home >> Server Configuration >> Tweak Settings</em>).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"Main"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Apache"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Basic"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Mail"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Main"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">module=Main</span></div><div><div html="<p>The
<a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/"><em>Tweak Settings</em></a>
interface section.</p>
<p><strong>Note:</strong></p>
<p>The possible section names are:</p>
<ul>
<li><code>Apache</code></li>
<li><code>Basic</code></li>
<li><code>Mail</code></li>
<li><code>Main</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The
<a href="https://docs.cpanel.net/whm/server-configuration/tweak-settings/"><em>Tweak Settings</em></a>
interface section.</p>
<p><strong>Note:</strong></p>
<p>The possible section names are:</p>
<ul>
<li><code>Apache</code></li>
<li><code>Basic</code></li>
<li><code>Mail</code></li>
<li><code>Main</code></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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">value=0</span></div><div><div html="<p>The value to assign to the setting. If you include this parameter in the call but
do <strong>not</strong> set a value, the value defaults to an empty value.</p>
<p><strong>Note:</strong></p>
<p>For more information about the requirements for values in the <code>cpanel.config</code>
file settings, read our
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/the-cpanel-config-file/"><code>cpanel.config</code> file</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The value to assign to the setting. If you include this parameter in the call but
do <strong>not</strong> set a value, the value defaults to an empty value.</p>
<p><strong>Note:</strong></p>
<p>For more information about the requirements for values in the <code>cpanel.config</code>
file settings, read our
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/the-cpanel-config-file/"><code>cpanel.config</code> file</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="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">/set_tweaksetting</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_tweaksetting</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4km5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4km5ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4km5ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4km5ca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4km5ca:0" aria-labelledby="tab:R4km5ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_tweaksetting <span class="token punctuation">\</span>
<span class="token assign-left variable">key</span><span class="token operator">=</span><span class="token string">'proxysubdomains'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4km5ca:1" aria-labelledby="tab:R4km5ca: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:R4sm5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sm5ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sm5ca:0" aria-labelledby="tab:R4sm5ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_tweaksetting"</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/Configurations/operation/get_tweaksetting" data-section-id="tag/Configurations/operation/get_tweaksetting" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_tweaksetting" id="operation/get_tweaksetting" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Configurations/operation/get_tweaksetting" aria-label="tag/Configurations/operation/get_tweaksetting"></a>Return Tweak Settings option's value<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves values from the
<a href="https://go.cpanel.net/ThecpanelconfigFile"><code>/var/cpanel/cpanel.config</code></a>
file and the server&#39;s <a href="https://go.cpanel.net/whmdocsEximConfigurationManager">Exim configuration</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves values from the
<a href="https://go.cpanel.net/ThecpanelconfigFile"><code>/var/cpanel/cpanel.config</code></a>
file and the server's <a href="https://go.cpanel.net/whmdocsEximConfigurationManager">Exim configuration</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="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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=defaultmailaction</span></div><div><div html="<p>The <a href="https://go.cpanel.net/whmdocsTweakSettings"><em>Tweak Settings</em></a> option.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://go.cpanel.net/whmdocsTweakSettings"><em>Tweak Settings</em></a> option.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"Main"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Apache"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Basic"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Mail"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Main"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">module=Main</span></div><div><div html="<p>One of the following <em>Tweak Settings</em> module names:</p>
<ul>
<li><code>Apache</code></li>
<li><code>Basic</code></li>
<li><code>Mail</code></li>
<li><code>Main</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>One of the following <em>Tweak Settings</em> module names:</p>
<ul>
<li><code>Apache</code></li>
<li><code>Basic</code></li>
<li><code>Mail</code></li>
<li><code>Main</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_tweaksetting</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_tweaksetting</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kq5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kq5ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kq5ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kq5ca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kq5ca:0" aria-labelledby="tab:R4kq5ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_tweaksetting <span class="token punctuation">\</span>
<span class="token assign-left variable">key</span><span class="token operator">=</span><span class="token string">'defaultmailaction'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kq5ca:1" aria-labelledby="tab:R4kq5ca: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:R4sq5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sq5ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sq5ca:0" aria-labelledby="tab:R4sq5ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"tweaksetting"</span>: <button class="collapser" aria-label="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">"defaultmailaction"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"localuser"</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"get_tweaksetting"</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/Connected-Applications" data-section-id="tag/Connected-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/Connected-Applications" aria-label="tag/Connected-Applications"></a>Connected Applications</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Server Administration / Connected Applications</p>
"><p>Server Administration / Connected Applications</p>
</div></div></div><div id="tag/Connected-Applications/operation/list_connected_applications" data-section-id="tag/Connected-Applications/operation/list_connected_applications" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_connected_applications" id="operation/list_connected_applications" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Connected-Applications/operation/list_connected_applications" aria-label="tag/Connected-Applications/operation/list_connected_applications"></a>List application connection information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>Retrieve the connection information for all the connected applications that have been
granted access to this server. This data may include any number of properties, but its
primary purpose is to associate API tokens and public/private key pairs and similar
resources with a specific connected application.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Retrieve the connection information for all the connected applications that have been
granted access to this server. This data may include any number of properties, but its
primary purpose is to associate API tokens and public/private key pairs and similar
resources with a specific connected 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/list_connected_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_connected_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:R9967ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9967ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R9967ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R9967ca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9967ca:0" aria-labelledby="tab:R9967ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_connected_applications
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9967ca:1" aria-labelledby="tab:R9967ca: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:R9p67ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p67ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p67ca:0" aria-labelledby="tab:R9p67ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"list"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"jwt"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"callback_url"</span>: <span class="token string">"</span><a href="https://application-1.com/api/si/servers/registrations/callback">https://application-1.com/api/si/servers/registrations/callback</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"challenge"</span>: <span class="token string">"ddd13a92-d55e-4818-a960-9776ede6cd74"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"john.doe@email.example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exp"</span>: <span class="token number">1401912171</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ips"</span>: <button class="collapser" aria-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><li><div class="hoverable "><span class="token string">"2.2.2.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">"iss"</span>: <span class="token string">"</span><a href="https://application-1.com">https://application-1.com</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"iss_desc"</span>: <span class="token string">"Sample application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"redirect_url"</span>: <span class="token string">"</span><a href="https://application-1/redirect">https://application-1/redirect</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scope"</span>: <button class="collapser" aria-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:users"</span>,</div></li><li><div class="hoverable "><span class="token string">"admin:resellers"</span>,</div></li><li><div class="hoverable "><span class="token string">"admin:domains"</span></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">"xyz"</span></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">"application-1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private_key"</span>: <span class="token string">"FEF6253E6A122532430D"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"public_key"</span>: <span class="token string">"AAF6253E6A1225324305623EE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token_name"</span>: <span class="token string">"Application 1 API Token"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"property1"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"property2"</span>: <span class="token keyword">null</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">"metadata"</span>: <button class="collapser" aria-label="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">"list_connected_applications"</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/Connected-Applications/operation/save_connected_application" data-section-id="tag/Connected-Applications/operation/save_connected_application" class="sc-dntaoT ceciOs"><div data-section-id="operation/save_connected_application" id="operation/save_connected_application" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Connected-Applications/operation/save_connected_application" aria-label="tag/Connected-Applications/operation/save_connected_application"></a>Save application connection information.<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>Save or update connection data about a specific connected application.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Save or update connection data about a specific connected 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><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=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><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>Data associated with the connected application. There are predefined elements related to specific security scenarios, but additional data may be stored here as well.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Data associated with the connected application. There are predefined elements related to specific security scenarios, but additional data may be stored here as well.</p>
</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The name of the connected application.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the connected application.</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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/save_connected_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/save_connected_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:R99a7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99a7ca:0" tabindex="0" data-rttab="true">Payload</li><li class="react-tabs__tab" role="tab" id="tab:R99a7ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99a7ca:1" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99a7ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99a7ca: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:R99a7ca:0" aria-labelledby="tab:R99a7ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"jwt"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"callback_url"</span>: <span class="token string">"</span><a href="https://application-1.com/api/si/servers/registrations/callback">https://application-1.com/api/si/servers/registrations/callback</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"challenge"</span>: <span class="token string">"ddd13a92-d55e-4818-a960-9776ede6cd74"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"john.doe@email.example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exp"</span>: <span class="token number">1401912171</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ips"</span>: <button class="collapser" aria-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><li><div class="hoverable "><span class="token string">"2.2.2.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">"iss"</span>: <span class="token string">"</span><a href="https://application-1.com">https://application-1.com</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"iss_desc"</span>: <span class="token string">"Sample application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"redirect_url"</span>: <span class="token string">"</span><a href="https://application-1/redirect">https://application-1/redirect</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scope"</span>: <button class="collapser" aria-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:users"</span>,</div></li><li><div class="hoverable "><span class="token string">"admin:resellers"</span>,</div></li><li><div class="hoverable "><span class="token string">"admin:domains"</span></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">"xyz"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private_key"</span>: <span class="token string">"FEF6253E6A122532430D"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"public_key"</span>: <span class="token string">"AAF6253E6A1225324305623EE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token_name"</span>: <span class="token string">"Application 1 API Token"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"property1"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"property2"</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">"name"</span>: <span class="token string">"application-1"</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:R99a7ca:1" aria-labelledby="tab:R99a7ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99a7ca:2" aria-labelledby="tab:R99a7ca: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:R9pa7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pa7ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pa7ca:0" aria-labelledby="tab:R9pa7ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"save_connected_application"</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/Connected-Applications/operation/fetch_connected_application" data-section-id="tag/Connected-Applications/operation/fetch_connected_application" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_connected_application" id="operation/fetch_connected_application" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Connected-Applications/operation/fetch_connected_application" aria-label="tag/Connected-Applications/operation/fetch_connected_application"></a>Fetch application connection information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>Retrieve the connection information related to a application that has been granted
access to this server. This data may include any number of properties, but its
primary purpose is to associate API tokens and public/private key pairs and similar
resources with a specific connected application.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Retrieve the connection information related to a application that has been granted
access to this server. This data may include any number of properties, but its
primary purpose is to associate API tokens and public/private key pairs and similar
resources with a specific connected 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="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=application-1</span></div><div><div html="<p>The name of the connected application.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the connected application.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/fetch_connected_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/fetch_connected_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:R99e7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99e7ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99e7ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99e7ca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99e7ca:0" aria-labelledby="tab:R99e7ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
fetch_connected_application <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'application-1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99e7ca:1" aria-labelledby="tab:R99e7ca: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:R9pe7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pe7ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pe7ca:0" aria-labelledby="tab:R9pe7ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"jwt"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"callback_url"</span>: <span class="token string">"</span><a href="https://application-1.com/api/si/servers/registrations/callback,">https://application-1.com/api/si/servers/registrations/callback,</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"challenge"</span>: <span class="token string">"ddd13a92-d55e-4818-a960-9776ede6cd74,"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"john.doe@email.example,"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exp"</span>: <span class="token string">"1401912171,"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ips"</span>: <button class="collapser" aria-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><li><div class="hoverable "><span class="token string">"2.2.2.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">"iss"</span>: <span class="token string">"</span><a href="https://application-1.com">https://application-1.com</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"iss_desc"</span>: <span class="token string">"Sample application"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"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">"redirect_url"</span>: <span class="token string">"</span><a href="https://application-1/redirect,">https://application-1/redirect,</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scope"</span>: <button class="collapser" aria-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:users,"</span>,</div></li><li><div class="hoverable "><span class="token string">"admin:resellers"</span>,</div></li><li><div class="hoverable "><span class="token string">"admin:domains"</span></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">"xyz"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private_key"</span>: <span class="token string">"FEF6253E6A122532430D"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"privileges_granted"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"list-accts"</span>,</div></li><li><div class="hoverable "><span class="token string">"list-resellers"</span>,</div></li><li><div class="hoverable "><span class="token string">"create-user-session"</span>,</div></li><li><div class="hoverable "><span class="token string">"acct-summary"</span>,</div></li><li><div class="hoverable "><span class="token string">"connected-applications"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"public_key"</span>: <span class="token string">"AAF6253E6A1225324305623EE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token_name"</span>: <span class="token string">"Application 1 API Token"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"property1"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"property2"</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">"name"</span>: <span class="token string">"application-1"</span></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">"command"</span>: <span class="token string">"fetch_connected_application"</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/Connected-Applications/operation/remove_connected_application" data-section-id="tag/Connected-Applications/operation/remove_connected_application" class="sc-dntaoT ceciOs"><div data-section-id="operation/remove_connected_application" id="operation/remove_connected_application" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Connected-Applications/operation/remove_connected_application" aria-label="tag/Connected-Applications/operation/remove_connected_application"></a>Remove application connection information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>Remove the connected application from the server. This only removes the connection
information from the configuration file. It does not clean up any allocated
resources, such as API tokens and public/private keys. Any tokens or keys need to be
removed from the system separately.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Remove the connected application from the server. This only removes the connection
information from the configuration file. It does not clean up any allocated
resources, such as API tokens and public/private keys. Any tokens or keys need to be
removed from the system separately.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=application-1</span></div><div><div html="<p>The name of the connected application.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the connected application.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/remove_connected_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remove_connected_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:R99i7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99i7ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99i7ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99i7ca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99i7ca:0" aria-labelledby="tab:R99i7ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remove_connected_application <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'application-1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99i7ca:1" aria-labelledby="tab:R99i7ca: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:R9pi7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pi7ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pi7ca:0" aria-labelledby="tab:R9pi7ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"remove_connected_application"</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/Connections" data-section-id="tag/Connections" 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/Connections" aria-label="tag/Connections"></a>Connections</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Server Administration / Connections</p>
"><p>Server Administration / Connections</p>
</div></div></div><div id="tag/Connections/operation/get_tcp6_sockets" data-section-id="tag/Connections/operation/get_tcp6_sockets" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_tcp6_sockets" id="operation/get_tcp6_sockets" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Connections/operation/get_tcp6_sockets" aria-label="tag/Connections/operation/get_tcp6_sockets"></a>Return TCP IPv6 sockets data<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns data about the system&#39;s transmission control protocol (TCP) IPv6 sockets.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns data about the system's transmission control protocol (TCP) IPv6 sockets.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_tcp6_sockets</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_tcp6_sockets</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R9969ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9969ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R9969ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R9969ca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9969ca:0" aria-labelledby="tab:R9969ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_tcp6_sockets
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9969ca:1" aria-labelledby="tab:R9969ca: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:R9p69ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p69ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p69ca:0" aria-labelledby="tab:R9p69ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dport"</span>: <span class="token number">443</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dst"</span>: <span class="token string">"2001:0db8:0:0:1:0:0:1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inode"</span>: <span class="token number">27171</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rqueue"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sport"</span>: <span class="token number">2087</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"src"</span>: <span class="token string">"2001:0db8:0:0:1:0:0:2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token number">10</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uid"</span>: <span class="token number">102</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"wqueue"</span>: <span class="token number">45</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_tcp6_sockets"</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/Connections/operation/get_udp4_sockets" data-section-id="tag/Connections/operation/get_udp4_sockets" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_udp4_sockets" id="operation/get_udp4_sockets" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Connections/operation/get_udp4_sockets" aria-label="tag/Connections/operation/get_udp4_sockets"></a>Return UDP IPv4 sockets data<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns data about the system&#39;s user datagram protocol (UDP) IPv4 sockets.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns data about the system's user datagram protocol (UDP) IPv4 sockets.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_udp4_sockets</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_udp4_sockets</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99a9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99a9ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99a9ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99a9ca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99a9ca:0" aria-labelledby="tab:R99a9ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_udp4_sockets
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99a9ca:1" aria-labelledby="tab:R99a9ca: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:R9pa9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pa9ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pa9ca:0" aria-labelledby="tab:R9pa9ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dport"</span>: <span class="token number">443</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dst"</span>: <span class="token string">"10.0.0.2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inode"</span>: <span class="token number">27171</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rqueue"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sport"</span>: <span class="token number">53</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"src"</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">"state"</span>: <span class="token number">10</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uid"</span>: <span class="token number">25</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"wqueue"</span>: <span class="token number">45</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_udp4_sockets"</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/Connections/operation/get_tcp4_sockets" data-section-id="tag/Connections/operation/get_tcp4_sockets" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_tcp4_sockets" id="operation/get_tcp4_sockets" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Connections/operation/get_tcp4_sockets" aria-label="tag/Connections/operation/get_tcp4_sockets"></a>Return TCP IPv4 sockets data<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns data about the system&#39;s transmission control protocol (TCP) IPv4 sockets.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns data about the system's transmission control protocol (TCP) IPv4 sockets.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_tcp4_sockets</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_tcp4_sockets</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99e9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99e9ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99e9ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99e9ca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99e9ca:0" aria-labelledby="tab:R99e9ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_tcp4_sockets
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99e9ca:1" aria-labelledby="tab:R99e9ca: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:R9pe9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pe9ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pe9ca:0" aria-labelledby="tab:R9pe9ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dport"</span>: <span class="token number">443</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dst"</span>: <span class="token string">"10.0.0.2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inode"</span>: <span class="token number">27171</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rqueue"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sport"</span>: <span class="token number">2087</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"src"</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">"state"</span>: <span class="token number">10</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uid"</span>: <span class="token number">102</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"wqueue"</span>: <span class="token number">45</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_tcp4_sockets"</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/Connections/operation/get_udp6_sockets" data-section-id="tag/Connections/operation/get_udp6_sockets" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_udp6_sockets" id="operation/get_udp6_sockets" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Connections/operation/get_udp6_sockets" aria-label="tag/Connections/operation/get_udp6_sockets"></a>Return UDP IPv6 sockets data<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns data about the system&#39;s user datagram protocol (UDP) IPv6 sockets.</p>
<p><strong>Important:</strong></p>
<p> This function may perform slower on a CentOS 6 system with a large number of UDP sockets.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns data about the system's user datagram protocol (UDP) IPv6 sockets.</p>
<p><strong>Important:</strong></p>
<p> This function may perform slower on a CentOS 6 system with a large number of UDP sockets.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_udp6_sockets</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_udp6_sockets</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99i9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99i9ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99i9ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99i9ca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99i9ca:0" aria-labelledby="tab:R99i9ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_udp6_sockets
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99i9ca:1" aria-labelledby="tab:R99i9ca: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:R9pi9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pi9ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pi9ca:0" aria-labelledby="tab:R9pi9ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dport"</span>: <span class="token number">443</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dst"</span>: <span class="token string">"2001:0db8:0:0:1:0:0:2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inode"</span>: <span class="token number">27171</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rqueue"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sport"</span>: <span class="token number">53</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"src"</span>: <span class="token string">"2001:0db8:0:0:1:0:0:1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token number">10</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uid"</span>: <span class="token number">25</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"wqueue"</span>: <span class="token number">45</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_udp6_sockets"</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/cPanel-Analytics" data-section-id="tag/cPanel-Analytics" 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-Analytics" aria-label="tag/cPanel-Analytics"></a>cPanel Analytics</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>The cPanel Analytics module for WHM API 1.</p>
"><p>The cPanel Analytics module for WHM API 1.</p>
</div></div></div><div id="tag/cPanel-Analytics/operation/participate_in_analytics" data-section-id="tag/cPanel-Analytics/operation/participate_in_analytics" class="sc-dntaoT ceciOs"><div data-section-id="operation/participate_in_analytics" id="operation/participate_in_analytics" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Analytics/operation/participate_in_analytics" aria-label="tag/cPanel-Analytics/operation/participate_in_analytics"></a>Enable analytics data gathering<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables or disables
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-analytics-the-data-we-use/#interface-analytics">Interface Analytics</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables or disables
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-analytics-the-data-we-use/#interface-analytics">Interface Analytics</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="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 Interface Analytics.</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 Interface Analytics.</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="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">/participate_in_analytics</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/participate_in_analytics</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aebca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aebca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aebca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aebca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aebca:0" aria-labelledby="tab:R2aebca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
participate_in_analytics <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:R2aebca:1" aria-labelledby="tab:R2aebca: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:R2eebca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eebca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eebca:0" aria-labelledby="tab:R2eebca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"participate_in_analytics"</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/License-Management" data-section-id="tag/License-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/License-Management" aria-label="tag/License-Management"></a>License Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>The Server Administration module for WHM API 1.</p>
"><p>The Server Administration module for WHM API 1.</p>
</div></div></div><div id="tag/License-Management/operation/purchase_a_license" data-section-id="tag/License-Management/operation/purchase_a_license" class="sc-dntaoT ceciOs"><div data-section-id="operation/purchase_a_license" id="operation/purchase_a_license" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/License-Management/operation/purchase_a_license" aria-label="tag/License-Management/operation/purchase_a_license"></a>Return cPanel Store or Market checkout URL<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the checkout URL to use for a cPanel Store or cPanel Market provider purchase.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the checkout URL to use for a cPanel Store or cPanel Market provider purchase.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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=1a676e6f-99fc-11e6-9ab6-e60a769b73bc</span></div><div><div html="<p>The login token to access the cPanel Store.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The login token to access the cPanel Store.</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 Store or cPanel Market provider&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Store or cPanel Market provider's name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="upgrade" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">upgrade</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">upgrade=1</span></div><div><div html="<p>Whether the cPanel Store or cPanel Market provider should treat this request as an upgrade.</p>
<ul>
<li><code>1</code> — An upgrade.</li>
<li><code>0</code> — <strong>Not</strong> an upgrade.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the cPanel Store or cPanel Market provider should treat this request as an upgrade.</p>
<ul>
<li><code>1</code> — An upgrade.</li>
<li><code>0</code> — <strong>Not</strong> an upgrade.</li>
</ul>
</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://hostname.example.com</span></div><div><div html="<p>The location to which the cPanel Store or cPanel Market provider directs the user after the checkout process finishes.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The location to which the cPanel Store or cPanel Market provider directs the user after the checkout process finishes.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/purchase_a_license</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/purchase_a_license</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kmdca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kmdca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kmdca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmdca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kmdca:0" aria-labelledby="tab:R4kmdca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
purchase_a_license <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_checkout</span><span class="token operator">=</span><span class="token string">'http://hostname.example.com'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">login_token</span><span class="token operator">=</span><span class="token string">'1a676e6f-99fc-11e6-9ab6-e60a769b73bc'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmdca:1" aria-labelledby="tab:R4kmdca: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:R4smdca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4smdca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4smdca:0" aria-labelledby="tab:R4smdca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><span class="token string">"</span><a href="https://store.cpanel.net/checkout/ssl/1234567">https://store.cpanel.net/checkout/ssl/1234567</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">"metadata"</span>: <button class="collapser" aria-label="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">"purchase_a_license"</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/License-Management/operation/run_cpkeyclt" data-section-id="tag/License-Management/operation/run_cpkeyclt" class="sc-dntaoT ceciOs"><div data-section-id="operation/run_cpkeyclt" id="operation/run_cpkeyclt" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/License-Management/operation/run_cpkeyclt" aria-label="tag/License-Management/operation/run_cpkeyclt"></a>Return server's cPanel license status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function verifies the system&#39;s license status with WebPros International, LLC&#39;s
licensing servers. To do this, the function runs the <code>/usr/local/cpanel/cpkeyclt</code>
script.</p>
<p>For more information about this script and potential license problems,
read our
<a href="https://docs.cpanel.net/installation-guide/troubleshoot-your-installation/">Installation Guide - Troubleshoot Your Installation</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function verifies the system's license status with WebPros International, LLC's
licensing servers. To do this, the function runs the <code>/usr/local/cpanel/cpkeyclt</code>
script.</p>
<p>For more information about this script and potential license problems,
read our
<a href="https://docs.cpanel.net/installation-guide/troubleshoot-your-installation/">Installation Guide - Troubleshoot Your Installation</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="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">/run_cpkeyclt</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/run_cpkeyclt</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kqdca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kqdca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kqdca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqdca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kqdca:0" aria-labelledby="tab:R4kqdca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
run_cpkeyclt
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqdca:1" aria-labelledby="tab:R4kqdca: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:R4sqdca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sqdca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sqdca:0" aria-labelledby="tab:R4sqdca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"run_cpkeyclt"</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/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>Server Administration / Notifications</p>
"><p>Server Administration / Notifications</p>
</div></div></div><div id="tag/Notifications/operation/get_all_contact_importances" data-section-id="tag/Notifications/operation/get_all_contact_importances" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_all_contact_importances" id="operation/get_all_contact_importances" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications/operation/get_all_contact_importances" aria-label="tag/Notifications/operation/get_all_contact_importances"></a>Return Contact Manager event importance settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the importance of all application events in
WHM&#39;s
<a href="https://docs.cpanel.net/whm/server-contacts/contact-manager/"><em>Contact Manager</em></a>
interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Contacts &gt;&gt; Contact Manager</em>).</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the importance of all application events in
WHM's
<a href="https://docs.cpanel.net/whm/server-contacts/contact-manager/"><em>Contact Manager</em></a>
interface (<em>WHM >> Home >> Server Contacts >> Contact 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_all_contact_importances</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_all_contact_importances</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii6fca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii6fca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii6fca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii6fca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii6fca:0" aria-labelledby="tab:Rii6fca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_all_contact_importances
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii6fca:1" aria-labelledby="tab:Rii6fca: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:Rji6fca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji6fca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji6fca:0" aria-labelledby="tab:Rji6fca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"importances"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"app"</span>: <span class="token string">"wwwacct"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"event"</span>: <span class="token string">"*"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"importance"</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">"High"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_all_contact_importances"</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/Notifications/operation/get_application_contact_importance" data-section-id="tag/Notifications/operation/get_application_contact_importance" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_application_contact_importance" id="operation/get_application_contact_importance" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications/operation/get_application_contact_importance" aria-label="tag/Notifications/operation/get_application_contact_importance"></a>Return app contact importance setting<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the importance level of an application&#39;s events for WHM&#39;s
<a href="https://docs.cpanel.net/whm/server-contacts/contact-manager/"><em>Contact Manager</em></a>
interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Contacts &gt;&gt; Contact Manager</em>).</p>
<p><strong>Note:</strong></p>
<p>The system creates a notification setting for the application&#39;s events if one does
not already exist.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the importance level of an application's events for WHM's
<a href="https://docs.cpanel.net/whm/server-contacts/contact-manager/"><em>Contact Manager</em></a>
interface (<em>WHM >> Home >> Server Contacts >> Contact Manager</em>).</p>
<p><strong>Note:</strong></p>
<p>The system creates a notification setting for the application's events if one does
not already 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="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=Check</span></div><div><div html="<p>The cPanel &amp; WHM application module&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel & WHM application module'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_application_contact_importance</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_application_contact_importance</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiafca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiafca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiafca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiafca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiafca:0" aria-labelledby="tab:Riiafca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_application_contact_importance <span class="token punctuation">\</span>
<span class="token assign-left variable">app</span><span class="token operator">=</span><span class="token string">'Check'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiafca:1" aria-labelledby="tab:Riiafca: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:Rjiafca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiafca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiafca:0" aria-labelledby="tab:Rjiafca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"importance"</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">"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>: <button class="collapser" aria-label="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">"get_application_contact_importance"</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/Notifications/operation/get_application_contact_event_importance" data-section-id="tag/Notifications/operation/get_application_contact_event_importance" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_application_contact_event_importance" id="operation/get_application_contact_event_importance" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications/operation/get_application_contact_event_importance" aria-label="tag/Notifications/operation/get_application_contact_event_importance"></a>Return app's event contact importance setting<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the importance level of an application event for WHM&#39;s Contact Manager interface (Home &gt;&gt; Server Contacts &gt;&gt; Contact Manager).</p>
<p><strong>Note:</strong></p>
<p> The system will create a notification setting for the application&#39;s events if one does not already exist.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the importance level of an application event for WHM's Contact Manager interface (Home >> Server Contacts >> Contact Manager).</p>
<p><strong>Note:</strong></p>
<p> The system will create a notification setting for the application's events if one does not already 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="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=Check</span></div><div><div html="<p>The application module&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application module's name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="event" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">event</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">event=SecurityAdvisorStateChange</span></div><div><div html="<p>The event&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The event'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_application_contact_event_importance</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_application_contact_event_importance</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiefca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiefca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiefca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiefca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiefca:0" aria-labelledby="tab:Riiefca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_application_contact_event_importance <span class="token punctuation">\</span>
<span class="token assign-left variable">app</span><span class="token operator">=</span><span class="token string">'Check'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">event</span><span class="token operator">=</span><span class="token string">'SecurityAdvisorStateChange'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiefca:1" aria-labelledby="tab:Riiefca: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:Rjiefca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiefca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiefca:0" aria-labelledby="tab:Rjiefca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"importance"</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">"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>: <button class="collapser" aria-label="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">"get_application_contact_event_importance"</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/Notifications/operation/set_application_contact_event_importance" data-section-id="tag/Notifications/operation/set_application_contact_event_importance" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_application_contact_event_importance" id="operation/set_application_contact_event_importance" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications/operation/set_application_contact_event_importance" aria-label="tag/Notifications/operation/set_application_contact_event_importance"></a>Update app's event contact importance setting<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the importance level of an application event for WHM&#39;s
<a href="https://go.cpanel.net/whmdocsContactManager"><em>Contact Manager</em></a>
interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Contacts &gt;&gt; Contact Manager</em>).</p>
<p>For a list of available modules, use the WHM API 1
<a href="/openapi/whm/operation/get_all_contact_importances/"><code>get_all_contact_importances</code></a>
function.</p>
<p><strong>Note:</strong></p>
<p>The system creates a notification setting for the application&#39;s events
if one does not already exist.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the importance level of an application event for WHM's
<a href="https://go.cpanel.net/whmdocsContactManager"><em>Contact Manager</em></a>
interface (<em>WHM >> Home >> Server Contacts >> Contact Manager</em>).</p>
<p>For a list of available modules, use the WHM API 1
<a href="/openapi/whm/operation/get_all_contact_importances/"><code>get_all_contact_importances</code></a>
function.</p>
<p><strong>Note:</strong></p>
<p>The system creates a notification setting for the application's events
if one does not already 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="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=Check</span></div><div><div html="<p>The cPanel &amp; WHM application module&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel & WHM application module's name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="event" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">event</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">event=SecurityAdvisorStateChange</span></div><div><div html="<p>The event&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The event's name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="importance" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">importance</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"High"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Medium"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Low"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Disabled"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">importance=Disabled</span></div><div><div html="<p>The importance level at which to send the notification.</p>
<ul>
<li><code>High</code></li>
<li><code>Medium</code></li>
<li><code>Low</code></li>
<li><code>Disabled</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The importance level at which to send the notification.</p>
<ul>
<li><code>High</code></li>
<li><code>Medium</code></li>
<li><code>Low</code></li>
<li><code>Disabled</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="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">/set_application_contact_event_importance</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_application_contact_event_importance</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiifca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiifca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiifca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiifca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiifca:0" aria-labelledby="tab:Riiifca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_application_contact_event_importance <span class="token punctuation">\</span>
<span class="token assign-left variable">app</span><span class="token operator">=</span><span class="token string">'Check'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">event</span><span class="token operator">=</span><span class="token string">'SecurityAdvisorStateChange'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">importance</span><span class="token operator">=</span><span class="token string">'Disabled'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiifca:1" aria-labelledby="tab:Riiifca: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:Rjiifca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiifca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiifca:0" aria-labelledby="tab:Rjiifca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_application_contact_event_importance"</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/Notifications/operation/set_application_contact_importance" data-section-id="tag/Notifications/operation/set_application_contact_importance" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_application_contact_importance" id="operation/set_application_contact_importance" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications/operation/set_application_contact_importance" aria-label="tag/Notifications/operation/set_application_contact_importance"></a>Update app contact importance setting<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the importance level of an application&#39;s events for WHM&#39;s
<a href="https://go.cpanel.net/whmdocsContactManager"><em>Contact Manager</em></a>
interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Contacts &gt;&gt; Contact Manager</em>).</p>
<p>For a list of available modules, use the WHM API 1
<a href="/openapi/whm/operation/get_all_contact_importances/"><code>get_all_contact_importances</code></a>
function.</p>
<p><strong>Note:</strong></p>
<p>The system creates a notification setting for the application&#39;s events if one
does not already exist.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the importance level of an application's events for WHM's
<a href="https://go.cpanel.net/whmdocsContactManager"><em>Contact Manager</em></a>
interface (<em>WHM >> Home >> Server Contacts >> Contact Manager</em>).</p>
<p>For a list of available modules, use the WHM API 1
<a href="/openapi/whm/operation/get_all_contact_importances/"><code>get_all_contact_importances</code></a>
function.</p>
<p><strong>Note:</strong></p>
<p>The system creates a notification setting for the application's events if one
does not already 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="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=Check</span></div><div><div html="<p>The cPanel &amp; WHM application module&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel & WHM application module's name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="importance" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">importance</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"High"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Medium"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Low"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Disabled"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">importance=Disabled</span></div><div><div html="<p>The importance level at which to send the notification.</p>
<ul>
<li><code>High</code></li>
<li><code>Medium</code></li>
<li><code>Low</code></li>
<li><code>Disabled</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The importance level at which to send the notification.</p>
<ul>
<li><code>High</code></li>
<li><code>Medium</code></li>
<li><code>Low</code></li>
<li><code>Disabled</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="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">/set_application_contact_importance</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_application_contact_importance</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riimfca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riimfca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riimfca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riimfca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riimfca:0" aria-labelledby="tab:Riimfca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_application_contact_importance <span class="token punctuation">\</span>
<span class="token assign-left variable">app</span><span class="token operator">=</span><span class="token string">'Check'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">importance</span><span class="token operator">=</span><span class="token string">'Disabled'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riimfca:1" aria-labelledby="tab:Riimfca: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:Rjimfca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjimfca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjimfca:0" aria-labelledby="tab:Rjimfca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_application_contact_importance"</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/Notifications/operation/send_test_posturl" data-section-id="tag/Notifications/operation/send_test_posturl" class="sc-dntaoT ceciOs"><div data-section-id="operation/send_test_posturl" id="operation/send_test_posturl" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications/operation/send_test_posturl" aria-label="tag/Notifications/operation/send_test_posturl"></a>Send notification URL via POST<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function uses the specified URL to send a test message through the POST method of HTTP as form data.
The function automatically generates a message title and body and includes a unique string in the test message.
When the test message returns, the system searches for the ID string and returns it.</p>
<p>If the function does not detect the correct ID string in the returned message, the function fails.</p>
<p>The test&#39;s success or failure depends on various conditions. For example:</p>
<ul>
<li>Valid access token.</li>
<li>Network configuration.</li>
<li>Service outages.</li>
<li>External server rate limit.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function uses the specified URL to send a test message through the POST method of HTTP as form data.
The function automatically generates a message title and body and includes a unique string in the test message.
When the test message returns, the system searches for the ID string and returns it.</p>
<p>If the function does not detect the correct ID string in the returned message, the function fails.</p>
<p>The test's success or failure depends on various conditions. For example:</p>
<ul>
<li>Valid access token.</li>
<li>Network configuration.</li>
<li>Service outages.</li>
<li>External server rate limit.</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="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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">url=https%3A%2F%2Fwww.example.com%2Fevents.cgi%3Fapikey%3D12345%26user%3Dusername*password%3D12345luggage</span></div><div><div html="<p>The URL and query string to send in uuencoded format. The system automatically sends the parameter&#39;s hostname, subject, and body with the relevant data from the alert.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To send additional parameters, include those keys after the URL. For example, to send the <code>apikey</code> parameter with a value of <code>XXXXX</code>, append <code>?apikey=XXXXX</code> to the URL.</li>
<li>To add additional parameters and values, separate those additional values with the ampersand character (<code>&amp;</code>) instead of the question mark character (<code>?</code>). For example, to include a <code>state</code> parameter of <code>Texas</code> and a <code>status</code> parameter of <code>CRITICAL</code>, append <code>?apikey=XXXXX&amp;state=Texas&amp;status=CRITICAL</code> to the URL.</li>
<li>If you enter a secure URL (<code>https://</code>), that site&#39;s certificate <strong>must</strong> be valid.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The URL and query string to send in uuencoded format. The system automatically sends the parameter's hostname, subject, and body with the relevant data from the alert.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To send additional parameters, include those keys after the URL. For example, to send the <code>apikey</code> parameter with a value of <code>XXXXX</code>, append <code>?apikey=XXXXX</code> to the URL.</li>
<li>To add additional parameters and values, separate those additional values with the ampersand character (<code>&</code>) instead of the question mark character (<code>?</code>). For example, to include a <code>state</code> parameter of <code>Texas</code> and a <code>status</code> parameter of <code>CRITICAL</code>, append <code>?apikey=XXXXX&state=Texas&status=CRITICAL</code> to the URL.</li>
<li>If you enter a secure URL (<code>https://</code>), that site's certificate <strong>must</strong> be valid.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/send_test_posturl</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/send_test_posturl</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiqfca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiqfca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiqfca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiqfca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiqfca:0" aria-labelledby="tab:Riiqfca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
send_test_posturl <span class="token punctuation">\</span>
<span class="token assign-left variable">url</span><span class="token operator">=</span><span class="token string">'https%3A%2F%2Fwww.example.com%2Fevents.cgi%3Fapikey%3D12345%26user%3Dusername*password%3D12345luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiqfca:1" aria-labelledby="tab:Riiqfca: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:Rjiqfca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiqfca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiqfca:0" aria-labelledby="tab:Rjiqfca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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></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">"command"</span>: <span class="token string">"send_test_posturl"</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/Notifications/operation/update_contact_email" data-section-id="tag/Notifications/operation/update_contact_email" class="sc-dntaoT ceciOs"><div data-section-id="operation/update_contact_email" id="operation/update_contact_email" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications/operation/update_contact_email" aria-label="tag/Notifications/operation/update_contact_email"></a>Update WHM contact email address<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function updates the contact email address in the <code>wwwacct.conf</code> file.
For more information, read our
<a href="https://docs.cpanel.net/installation-guide/customize-your-installation/">Installation Guide - Customize Your Installation</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates the contact email address in the <code>wwwacct.conf</code> file.
For more information, read our
<a href="https://docs.cpanel.net/installation-guide/customize-your-installation/">Installation Guide - Customize Your Installation</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="contact_email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">contact_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">contact_email=user@example.com</span></div><div><div html="<p>The contact email address to add as the <code>wwwacct.conf</code> file&#39;s <code>CONTACTEMAIL</code>
setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The contact email address to add as the <code>wwwacct.conf</code> file's <code>CONTACTEMAIL</code>
setting.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/update_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/update_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:Riiufca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiufca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiufca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiufca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiufca:0" aria-labelledby="tab:Riiufca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
update_contact_email <span class="token punctuation">\</span>
<span class="token assign-left variable">contact_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:Riiufca:1" aria-labelledby="tab:Riiufca: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:Rjiufca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiufca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiufca:0" aria-labelledby="tab:Rjiufca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"update_contact_email"</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/Notifications/operation/send_test_pushbullet_note" data-section-id="tag/Notifications/operation/send_test_pushbullet_note" class="sc-dntaoT ceciOs"><div data-section-id="operation/send_test_pushbullet_note" id="operation/send_test_pushbullet_note" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications/operation/send_test_pushbullet_note" aria-label="tag/Notifications/operation/send_test_pushbullet_note"></a>Send Pushbullet™ test with access token<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function uses the specified access token to send a test Pushbullet™ note. The function automatically generates a message title and body, and it includes a unique string in the test message. When the test message returns, the system searches for the ID string and returns it.</p>
<p>If the function does not detect the correct ID string in the returned message, the function fails. You can also review the user&#39;s Pushbullet channel history to confirm that the server sent and received the message.</p>
<p>The test&#39;s success or failure depends on various conditions. For example:</p>
<ul>
<li>Valid access token.</li>
<li>Network configuration.</li>
<li>Service outages.</li>
<li>External server rate limit.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function uses the specified access token to send a test Pushbullet™ note. The function automatically generates a message title and body, and it includes a unique string in the test message. When the test message returns, the system searches for the ID string and returns it.</p>
<p>If the function does not detect the correct ID string in the returned message, the function fails. You can also review the user's Pushbullet channel history to confirm that the server sent and received the message.</p>
<p>The test's success or failure depends on various conditions. For example:</p>
<ul>
<li>Valid access token.</li>
<li>Network configuration.</li>
<li>Service outages.</li>
<li>External server rate limit.</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="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 token to use.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To access your Pushbullet token, navigate to <a href="https://www.pushbullet.com/account">Pushbullet&#39;s My Account</a> page. It will appear 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 token to use.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To access your Pushbullet token, navigate to <a href="https://www.pushbullet.com/account">Pushbullet's My Account</a> page. It will appear 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/send_test_pushbullet_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/send_test_pushbullet_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:Rij2fca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij2fca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij2fca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij2fca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij2fca:0" aria-labelledby="tab:Rij2fca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
send_test_pushbullet_note <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:Rij2fca:1" aria-labelledby="tab:Rij2fca: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:Rjj2fca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj2fca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj2fca:0" aria-labelledby="tab:Rjj2fca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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) can 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">"modifiedx"</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">"metadata"</span>: <button class="collapser" aria-label="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">"send_test_pushbullet_note"</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/Notifications/operation/verify_oscar_access" data-section-id="tag/Notifications/operation/verify_oscar_access" class="sc-dntaoT ceciOs"><div data-section-id="operation/verify_oscar_access" id="operation/verify_oscar_access" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications/operation/verify_oscar_access" aria-label="tag/Notifications/operation/verify_oscar_access"></a>Validate ICQ username and password<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function tests the ICQ credentials that the system uses for notifications. The system generates a unique string and includes it in the test message.</p>
<p>You can also review the user&#39;s ICQ message history to confirm that the server sent and received the message.</p>
<p>The test&#39;s success or failure depends on the following conditions:</p>
<ul>
<li>Valid username and password combination.</li>
<li>Network configuration.</li>
<li>Service outages.</li>
<li>External server rate limit.</li>
</ul>
<p><strong>Warning:</strong></p>
<p> AOL discontinued support for AIM in December 2017. This function only tests ICQ credentials, not AIM credentials.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function tests the ICQ credentials that the system uses for notifications. The system generates a unique string and includes it in the test message.</p>
<p>You can also review the user's ICQ message history to confirm that the server sent and received the message.</p>
<p>The test's success or failure depends on the following conditions:</p>
<ul>
<li>Valid username and password combination.</li>
<li>Network configuration.</li>
<li>Service outages.</li>
<li>External server rate limit.</li>
</ul>
<p><strong>Warning:</strong></p>
<p> AOL discontinued support for AIM in December 2017. This function only tests ICQ credentials, not AIM credentials.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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 ICQ account&#39;s password.</p>
<p> <strong>Note:</strong></p>
<p>You <strong>cannot</strong> use this function to test an AIM account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ICQ account's password.</p>
<p> <strong>Note:</strong></p>
<p>You <strong>cannot</strong> use this function to test an AIM account.</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 ICQ account.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>If the username value consists entirely of numbers, the system assumes that it is an ICQ account. Otherwise, the system treats the account as an AOL account.</li>
<li>You <strong>cannot</strong> use this function to test an AIM account.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ICQ account.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>If the username value consists entirely of numbers, the system assumes that it is an ICQ account. Otherwise, the system treats the account as an AOL account.</li>
<li>You <strong>cannot</strong> use this function to test an AIM 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/verify_oscar_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/verify_oscar_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:Rij6fca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij6fca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij6fca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij6fca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij6fca:0" aria-labelledby="tab:Rij6fca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
verify_oscar_access <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">'12345luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij6fca:1" aria-labelledby="tab:Rij6fca: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:Rjj6fca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj6fca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj6fca:0" aria-labelledby="tab:Rjj6fca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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></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">"command"</span>: <span class="token string">"verify_oscar_access"</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/Notifications/operation/verify_icq_access" data-section-id="tag/Notifications/operation/verify_icq_access" class="sc-dntaoT ceciOs"><div data-section-id="operation/verify_icq_access" id="operation/verify_icq_access" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications/operation/verify_icq_access" aria-label="tag/Notifications/operation/verify_icq_access"></a>Validate stored ICQ username and password<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function calls WHM API 1&#39;s <code>verify_oscar_access</code>
function with your specified ICQ accounts. You can specify ICQ
accounts in the <em>Contact Information</em> section of WHM&#39;s <a href="https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup/"><em>Basic WebHost Manager
Setup</em></a> interface (<em>Home &gt;&gt; Server Configuration &gt;&gt; Basic WebHost Manager
Setup</em>).</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function calls WHM API 1's <code>verify_oscar_access</code>
function with your specified ICQ accounts. You can specify ICQ
accounts in the <em>Contact Information</em> section of WHM's <a href="https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup/"><em>Basic WebHost Manager
Setup</em></a> interface (<em>Home >> Server Configuration >> Basic WebHost Manager
Setup</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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/verify_icq_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/verify_icq_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:Rijafca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijafca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijafca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijafca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijafca:0" aria-labelledby="tab:Rijafca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
verify_icq_access
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijafca:1" aria-labelledby="tab:Rijafca: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:Rjjafca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjafca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjafca:0" aria-labelledby="tab:Rjjafca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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></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">"command"</span>: <span class="token string">"verify_icq_access"</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/Notifications/operation/verify_posturl_access" data-section-id="tag/Notifications/operation/verify_posturl_access" class="sc-dntaoT ceciOs"><div data-section-id="operation/verify_posturl_access" id="operation/verify_posturl_access" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications/operation/verify_posturl_access" aria-label="tag/Notifications/operation/verify_posturl_access"></a>Send notification URL via POST verification<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function calls the WHM API 1 <code>send_test_posturl</code> function for
your specified POST notification URLs. Users can specify POST notification
URLs in the <em>Contact Information</em> section of WHM&#39;s
<a href="https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup"><em>Basic WebHost Manager Setup</em></a>
interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Basic WebHost Manager Setup</em>).</p>
<p><strong>Note:</strong></p>
<p>If the <em>Contact Information</em> section of WHM&#39;s
<a href="https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup"><em>Basic WebHost Manager Setup</em></a>
interface (<em>Home &gt;&gt; Server Configuration &gt;&gt; Basic WebHost Manager Setup</em>) contains
multiple POST URLs, the function will return an array that contains the results
for each URL.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function calls the WHM API 1 <code>send_test_posturl</code> function for
your specified POST notification URLs. Users can specify POST notification
URLs in the <em>Contact Information</em> section of WHM's
<a href="https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup"><em>Basic WebHost Manager Setup</em></a>
interface (<em>WHM >> Home >> Server Configuration >> Basic WebHost Manager Setup</em>).</p>
<p><strong>Note:</strong></p>
<p>If the <em>Contact Information</em> section of WHM's
<a href="https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup"><em>Basic WebHost Manager Setup</em></a>
interface (<em>Home >> Server Configuration >> Basic WebHost Manager Setup</em>) contains
multiple POST URLs, the function will return an array that contains the results
for each URL.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/verify_posturl_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/verify_posturl_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:Rijefca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijefca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijefca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijefca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijefca:0" aria-labelledby="tab:Rijefca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
verify_posturl_access
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijefca:1" aria-labelledby="tab:Rijefca: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:Rjjefca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjefca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjefca:0" aria-labelledby="tab:Rjjefca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"result"</span>: <button class="collapser" aria-label="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">"88M7"</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">"content"</span>: <span class="token string">"<!doctype html>\n<html>\n<head>\n <title>Example Domain</title>\n\n <meta charset=\"utf-8\" />\n <meta http-equiv=\"Content-type\" content=\"text/html; charset=utf-8\" />\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n <style type=\"text/css\">\n body {\n background-color: #f0f0f2;\n margin: 0;\n padding: 0;\n font-family: -apple-system, system-ui, BlinkMacSystemFont, \"Segoe UI\", \"Open Sans\", \"Helvetica Neue\", Helvetica, Arial, sans-serif;\n }\n div {\n width: 600px;\n margin: 5em auto;\n padding: 2em;\n background-color: #fdfdff;\n border-radius: 0.5em;\n box-shadow: 2px 3px 7px 2px rgba(0,0,0,0.02);\n }\n a:link, a:visited {\n color: #38488f;\n text-decoration: none;\n }\n @media (max-width: 700px) {\n div {\n margin: 0 auto;\n width: auto;\n }\n }\n </style>\n</head>\n\n<body>\n<div>\n <h1>Example Domain</h1>\n <p>This domain is for use in illustrative examples in documents. You may use this\n domain in literature without prior coordination or asking for permission.</p>\n <p><a href=\"https://www.iana.org/domains/example\">More information...</a></p>\n</div>\n</body>\n</html>\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"headers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"connection"</span>: <span class="token string">"keep-alive"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content-length"</span>: <span class="token string">"743"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content-type"</span>: <span class="token string">"application/json; charset=utf-8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token string">"Tue, 05 May 2020 19:10:13 GMT"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"e-tag"</span>: <span class="token string">"z'W/\\\"2e7-Klmw/9Djp5E2M7VZdH2LwFWXX6s\\\"\""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server"</span>: <span class="token string">"nginx"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"set-cookie"</span>: <span class="token string">"sails.sid=s%3Arpjt9JrVXDIYMxpjyUqLuCtcUxSwbEWX.6ldYuWKV2zqn%2BhmsUlAi7PtsIEd9RXI32y6gjg0gwJA; Path=/; HttpOnly"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vary"</span>: <span class="token string">"Accept-Encoding"</span></div></li></ul><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"</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 string">"200"</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">"url"</span>: <span class="token string">"</span><a href="http://www.example.com">http://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><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://postman-echo.com/post">https://postman-echo.com/post</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">"metadata"</span>: <button class="collapser" aria-label="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">"verify_posturl_access"</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/Notifications/operation/verify_pushbullet_access" data-section-id="tag/Notifications/operation/verify_pushbullet_access" class="sc-dntaoT ceciOs"><div data-section-id="operation/verify_pushbullet_access" id="operation/verify_pushbullet_access" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications/operation/verify_pushbullet_access" aria-label="tag/Notifications/operation/verify_pushbullet_access"></a>Send Pushbullet™ access verification<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function calls the WHM API 1 <code>send_test_pushbullet_note</code> function with the system&#39;s specified
Pushbullet™ accounts. You can specify Pushbullet accounts in the <em>Contact Information</em> section of WHM&#39;s
<em><a href="https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup/">Basic WebHost Manager Setup</a></em>
interface (<em>Home &gt;&gt; Server Configuration &gt;&gt; Basic WebHost Manager Setup</em>).</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function calls the WHM API 1 <code>send_test_pushbullet_note</code> function with the system's specified
Pushbullet™ accounts. You can specify Pushbullet accounts in the <em>Contact Information</em> section of WHM's
<em><a href="https://docs.cpanel.net/whm/server-configuration/basic-webhost-manager-setup/">Basic WebHost Manager Setup</a></em>
interface (<em>Home >> Server Configuration >> Basic WebHost Manager Setup</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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/verify_pushbullet_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/verify_pushbullet_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:Rijifca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijifca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijifca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijifca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijifca:0" aria-labelledby="tab:Rijifca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
verify_pushbullet_access
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijifca:1" aria-labelledby="tab:Rijifca: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:Rjjifca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjifca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjifca:0" aria-labelledby="tab:Rjjifca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"access_token"</span>: <span class="token string">"123456789012345678901234567890"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="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 string">"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) can send a\nmessage to you via Pushbullet.\n\nThis message was sent on Tuesday, March 17, 2020 at 3:09: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 string">"1584457760.74319,"</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 string">"false,"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"iden"</span>: <span class="token string">"ABCDEFGHIJKLABCDEFGHIJKL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modified"</span>: <span class="token string">"1584457760.74993,"</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">"ABCDEFGHIJKL"</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">"ABCDEFGHIJKL"</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: J2SY)"</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></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">"metadata"</span>: <button class="collapser" aria-label="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">"verify_pushbullet_access"</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/Notifications/operation/verify_slack_access" data-section-id="tag/Notifications/operation/verify_slack_access" class="sc-dntaoT ceciOs"><div data-section-id="operation/verify_slack_access" id="operation/verify_slack_access" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications/operation/verify_slack_access" aria-label="tag/Notifications/operation/verify_slack_access"></a>Verify Slack® Webhook connection<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function verifies the connection to a Slack® WebHook. You can specify Slack accounts in the Contact Information section of WHM&#39;s Basic WebHost Manager Setup interface ( Home &gt;&gt; Server Configuration &gt;&gt; Basic WebHost Manager Setup ).</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function verifies the connection to a Slack® WebHook. You can specify Slack accounts in the Contact Information section of WHM's Basic WebHost Manager Setup interface ( Home >> Server Configuration >> Basic WebHost Manager Setup ).</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/verify_slack_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/verify_slack_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:Rijmfca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijmfca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijmfca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijmfca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijmfca:0" aria-labelledby="tab:Rijmfca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
verify_slack_access
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijmfca:1" aria-labelledby="tab:Rijmfca: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:Rjjmfca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjmfca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjmfca:0" aria-labelledby="tab:Rjjmfca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"result"</span>: <button class="collapser" aria-label="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 keyword">null</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">"content"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"headers"</span>: <button class="collapser" aria-label="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-control-allow-origin"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content-type"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"referrer-policy"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"strict-transport-security"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"transfer-encoding"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vary"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x-frame-options"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x-slack-backend"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x-via"</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">"protocol"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</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 keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</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">"url"</span>: <span class="token keyword">null</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">"metadata"</span>: <button class="collapser" aria-label="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">"verify_slack_access"</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/Security" data-section-id="tag/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/Security" aria-label="tag/Security"></a>Security</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>The Security module for WHM API 1.</p>
"><p>The Security module for WHM API 1.</p>
</div></div></div><div id="tag/Security/operation/fetch_security_advice" data-section-id="tag/Security/operation/fetch_security_advice" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_security_advice" id="operation/fetch_security_advice" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Security/operation/fetch_security_advice" aria-label="tag/Security/operation/fetch_security_advice"></a>Return Security Advisor results<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the cPanel Security Advisor&#39;s security scan data. It advises you of how to resolve any security issues that it finds.</p>
<p><strong>Note:</strong></p>
<p> For more information, read the <a href="https://go.cpanel.net/githubsecurityadvisor">cPanel Security Advisor</a> documentation at the WebPros International, LLC GitHub® repository.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the cPanel Security Advisor's security scan data. It advises you of how to resolve any security issues that it finds.</p>
<p><strong>Note:</strong></p>
<p> For more information, read the <a href="https://go.cpanel.net/githubsecurityadvisor">cPanel Security Advisor</a> documentation at the WebPros International, LLC GitHub® repository.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/fetch_security_advice</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/fetch_security_advice</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aehca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aehca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aehca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aehca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aehca:0" aria-labelledby="tab:R2aehca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
fetch_security_advice
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aehca:1" aria-labelledby="tab:R2aehca: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:R2eehca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eehca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eehca:0" aria-labelledby="tab:R2eehca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"advice"</span>: <button class="collapser" aria-label="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">"SSH_direct_root_login_permitted"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suggestion"</span>: <span class="token string">"Manually edit /etc/ssh/sshd_config and change PermitRootLogin to “without-password” or “no”, then restart SSH …"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <span class="token string">"SSH direct root logins are permitted."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"ADVISE_BAD"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Cpanel::Security::Advisor::Assessors::SSH"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"mod_advice"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"advice"</span>: <button class="collapser" aria-label="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">"SSH_is_current"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suggestion"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"summary"</span>: <span class="token string">"Current SSH version is up to date: 11.22p33-44"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"ADVISE_GOOD"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Cpanel::Security::Advisor::Assessors::SSH"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"mod_advice"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"Anvil not found at /usr/local/cpanel/Cpanel/Security/Advisor/Assessors/ACME.pm line 6."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Cpanel::Security::Advisor::Assessors::ACME"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"mod_load"</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">"metadata"</span>: <button class="collapser" aria-label="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">"fetch_security_advice"</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/Server-Nodes" data-section-id="tag/Server-Nodes" 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/Server-Nodes" aria-label="tag/Server-Nodes"></a>Server Nodes</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Server Administration / Server Nodes</p>
"><p>Server Administration / Server Nodes</p>
</div></div></div><div id="tag/Server-Nodes/operation/get_linked_server_node" data-section-id="tag/Server-Nodes/operation/get_linked_server_node" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_linked_server_node" id="operation/get_linked_server_node" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Nodes/operation/get_linked_server_node" aria-label="tag/Server-Nodes/operation/get_linked_server_node"></a>Return linked remote server node settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns details about a linked remote server node.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns details about a linked remote server node.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="alias" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">alias</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">alias=example</span></div><div><div html="<p>The name of a linked remote server node.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of a linked remote server node.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_linked_server_node</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_linked_server_node</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii6jca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii6jca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii6jca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii6jca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii6jca:0" aria-labelledby="tab:Rii6jca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_linked_server_node <span class="token punctuation">\</span>
<span class="token assign-left variable">alias</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:Rii6jca:1" aria-labelledby="tab:Rii6jca: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:Rji6jca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji6jca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji6jca:0" aria-labelledby="tab:Rji6jca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_services"</span>: <button class="collapser" aria-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_php_fpm"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hostname"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_check"</span>: <span class="token number">1556576165</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"system_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">"Mail"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"globalspamassassin"</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">"tls_verified"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"root"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"11.86.0.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"worker_capabilities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"Mail"</span>: <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">"metadata"</span>: <button class="collapser" aria-label="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">"get_linked_server_node"</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/Server-Nodes/operation/get_server_node_status" data-section-id="tag/Server-Nodes/operation/get_server_node_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_server_node_status" id="operation/get_server_node_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Nodes/operation/get_server_node_status" aria-label="tag/Server-Nodes/operation/get_server_node_status"></a>Return linked server node status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the status of a linked remote server node. It returns
the linked remote server&#39;s status with the WHM API 1 <code>version</code> and <code>get_current_profile</code> functions.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the status of a linked remote server node. It returns
the linked remote server's status with the WHM API 1 <code>version</code> and <code>get_current_profile</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=""><td kind="field" title="api_token" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">api_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">api_token=23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H</span></div><div><div html="<p>The required API token to make API calls to the remote server node.</p>
<p><strong>Note:</strong></p>
<p> The API token <strong>must</strong> have <code>root</code>-level access on the remote server node.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The required API token to make API calls to the remote server node.</p>
<p><strong>Note:</strong></p>
<p> The API token <strong>must</strong> have <code>root</code>-level access on the remote server node.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="hostname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">hostname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">hostname=example.com</span></div><div><div html="<p>The remote server node&#39;s hostname or IP address.</p>
<p><strong>Note:</strong></p>
<p>If you use an IP address, you <strong>must</strong> use the <code>skip_tls_verification=1</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server node's hostname or IP address.</p>
<p><strong>Note:</strong></p>
<p>If you use an IP address, you <strong>must</strong> use the <code>skip_tls_verification=1</code> parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="skip_tls_verification" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skip_tls_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">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_tls_verification=1</span></div><div><div html="<p>Whether to skip <a href="https://go.cpanel.net/guidetoSSL">SSL/TLS verification</a>. The system performs this action when it queries the remote server node.</p>
<ul>
<li><code>1</code> - Skip SSL/TLS verification.</li>
<li><code>0</code> - Do <strong>not</strong> skip SSL/TLS verification.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip <a href="https://go.cpanel.net/guidetoSSL">SSL/TLS verification</a>. The system performs this action when it queries the remote server node.</p>
<ul>
<li><code>1</code> - Skip SSL/TLS verification.</li>
<li><code>0</code> - Do <strong>not</strong> skip SSL/TLS verification.</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=root</span></div><div><div html="<p>The username required to make API calls to the remote server node.</p>
<p><strong>Note:</strong></p>
<p>The username <strong>must</strong> have <code>root</code>-level access on the remote server node.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username required to make API calls to the remote server node.</p>
<p><strong>Note:</strong></p>
<p>The username <strong>must</strong> have <code>root</code>-level access on the remote server node.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_server_node_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_server_node_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:Riiajca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiajca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiajca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiajca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiajca:0" aria-labelledby="tab:Riiajca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_server_node_status <span class="token punctuation">\</span>
<span class="token assign-left variable">api_token</span><span class="token operator">=</span><span class="token string">'23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">hostname</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">'root'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiajca:1" aria-labelledby="tab:Riiajca: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:Rjiajca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiajca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiajca:0" aria-labelledby="tab:Rjiajca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_services"</span>: <button class="collapser" aria-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_php_fpm"</span></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_node_linkages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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 string">"MailNode"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled_services"</span>: <button class="collapser" aria-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_php_fpm"</span>,</div></li><li><div class="hoverable "><span class="token string">"cpanellogd"</span>,</div></li><li><div class="hoverable "><span class="token string">"cpdavd"</span>,</div></li><li><div class="hoverable "><span class="token string">"cpgreylistd"</span>,</div></li><li><div class="hoverable "><span class="token string">"cphulkd"</span>,</div></li><li><div class="hoverable "><span class="token string">"cpsrvd"</span>,</div></li><li><div class="hoverable "><span class="token string">"crond"</span>,</div></li><li><div class="hoverable "><span class="token string">"dnsadmin"</span>,</div></li><li><div class="hoverable "><span class="token string">"exim"</span>,</div></li><li><div class="hoverable "><span class="token string">"imap"</span>,</div></li><li><div class="hoverable "><span class="token string">"ipaliases"</span>,</div></li><li><div class="hoverable "><span class="token string">"lmtp"</span>,</div></li><li><div class="hoverable "><span class="token string">"mailman"</span>,</div></li><li><div class="hoverable "><span class="token string">"mysql"</span>,</div></li><li><div class="hoverable "><span class="token string">"named"</span>,</div></li><li><div class="hoverable "><span class="token string">"nscd"</span>,</div></li><li><div class="hoverable "><span class="token string">"pop"</span>,</div></li><li><div class="hoverable "><span class="token string">"queueprocd"</span>,</div></li><li><div class="hoverable "><span class="token string">"rsyslogd"</span>,</div></li><li><div class="hoverable "><span class="token string">"spamd"</span>,</div></li><li><div class="hoverable "><span class="token string">"sshd"</span>,</div></li><li><div class="hoverable "><span class="token string">"tailwatchd"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hostname"</span>: <span class="token string">"mailnode.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_check"</span>: <span class="token number">1583934071</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"system_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">"Mail"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"globalspamassassin"</span>: <span class="token string">"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">"tls_verified"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"root"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"11.90.0.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"worker_capabilities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"Mail"</span>: <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">"system_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">"Mail"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"globalspamassassin"</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">"tls_verified"</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">"11.90.0.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">"metadata"</span>: <button class="collapser" aria-label="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">"get_server_node_status"</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/Server-Nodes/operation/list_linked_server_nodes" data-section-id="tag/Server-Nodes/operation/list_linked_server_nodes" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_linked_server_nodes" id="operation/list_linked_server_nodes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Nodes/operation/list_linked_server_nodes" aria-label="tag/Server-Nodes/operation/list_linked_server_nodes"></a>Return all linked server nodes<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a list of all remote server nodes linked to the server. It also provides details about each remote server node.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of all remote server nodes linked to the server. It also provides details about each remote server node.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_linked_server_nodes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_linked_server_nodes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiejca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiejca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiejca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiejca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiejca:0" aria-labelledby="tab:Riiejca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_linked_server_nodes
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiejca:1" aria-labelledby="tab:Riiejca: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:Rjiejca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiejca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiejca:0" aria-labelledby="tab:Rjiejca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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 string">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled_services"</span>: <button class="collapser" aria-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_php_fpm"</span>,</div></li><li><div class="hoverable "><span class="token string">"cpanellogd"</span>,</div></li><li><div class="hoverable "><span class="token string">"cpdavd"</span>,</div></li><li><div class="hoverable "><span class="token string">"cpgreylistd"</span>,</div></li><li><div class="hoverable "><span class="token string">"cpsrvd"</span>,</div></li><li><div class="hoverable "><span class="token string">"crond"</span>,</div></li><li><div class="hoverable "><span class="token string">"dnsadmin"</span>,</div></li><li><div class="hoverable "><span class="token string">"exim"</span>,</div></li><li><div class="hoverable "><span class="token string">"ftpd"</span>,</div></li><li><div class="hoverable "><span class="token string">"imap"</span>,</div></li><li><div class="hoverable "><span class="token string">"ipaliases"</span>,</div></li><li><div class="hoverable "><span class="token string">"lmtp"</span>,</div></li><li><div class="hoverable "><span class="token string">"mailman"</span>,</div></li><li><div class="hoverable "><span class="token string">"mysql"</span>,</div></li><li><div class="hoverable "><span class="token string">"named"</span>,</div></li><li><div class="hoverable "><span class="token string">"nscd"</span>,</div></li><li><div class="hoverable "><span class="token string">"pop"</span>,</div></li><li><div class="hoverable "><span class="token string">"postgresql"</span>,</div></li><li><div class="hoverable "><span class="token string">"queueprocd"</span>,</div></li><li><div class="hoverable "><span class="token string">"rsyslogd"</span>,</div></li><li><div class="hoverable "><span class="token string">"spamd"</span>,</div></li><li><div class="hoverable "><span class="token string">"sshd"</span>,</div></li><li><div class="hoverable "><span class="token string">"tailwatchd"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hostname"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_check"</span>: <span class="token number">1556576165</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tls_verified"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"root"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"11.90.0.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"worker_capabilities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"Mail"</span>: <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">"metadata"</span>: <button class="collapser" aria-label="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">"list_linked_server_nodes"</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/Server-Nodes/operation/list_user_child_nodes" data-section-id="tag/Server-Nodes/operation/list_user_child_nodes" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_user_child_nodes" id="operation/list_user_child_nodes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Nodes/operation/list_user_child_nodes" aria-label="tag/Server-Nodes/operation/list_user_child_nodes"></a>Return cPanel accounts with server name and type<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the system&#39;s cPanel accounts and the <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles">linked cPanel &amp; WHM server</a> on which they exist.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the system's cPanel accounts and the <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles">linked cPanel & WHM server</a> on which they 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_user_child_nodes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_user_child_nodes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiijca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiijca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiijca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiijca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiijca:0" aria-labelledby="tab:Riiijca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_user_child_nodes
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiijca:1" aria-labelledby="tab:Riiijca: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:Rjiijca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiijca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiijca:0" aria-labelledby="tab:Rjiijca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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 string">"MailServer1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"Mail"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">"username1"</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">"metadata"</span>: <button class="collapser" aria-label="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">"list_user_child_nodes"</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/Server-Nodes/operation/link_server_node_with_api_token" data-section-id="tag/Server-Nodes/operation/link_server_node_with_api_token" class="sc-dntaoT ceciOs"><div data-section-id="operation/link_server_node_with_api_token" id="operation/link_server_node_with_api_token" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Nodes/operation/link_server_node_with_api_token" aria-label="tag/Server-Nodes/operation/link_server_node_with_api_token"></a>Add linked server node<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function links your server to a remote server node. The server uses an API token
to communicate with the remote server node.</p>
<p><strong>Important:</strong></p>
<ul>
<li>This function <strong>only</strong> runs on a
<a href="https://go.cpanel.net/whmlinkednodes">Standard Node profile</a>
server.</li>
<li>The remote server node <strong>must</strong> use a version that is the same as or greater than your
server version.</li>
<li>This function <strong>requires</strong> the use of an API token. For more information, read our
<a href="https://go.cpanel.net/APITokensinWHM">Guide to API Authentication - API Tokens in WHM</a>
documentation.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function links your server to a remote server node. The server uses an API token
to communicate with the remote server node.</p>
<p><strong>Important:</strong></p>
<ul>
<li>This function <strong>only</strong> runs on a
<a href="https://go.cpanel.net/whmlinkednodes">Standard Node profile</a>
server.</li>
<li>The remote server node <strong>must</strong> use a version that is the same as or greater than your
server version.</li>
<li>This function <strong>requires</strong> the use of an API token. For more information, read our
<a href="https://go.cpanel.net/APITokensinWHM">Guide to API Authentication - API Tokens in WHM</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=""><td kind="field" title="alias" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">alias</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-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">alias=example</span></div><div><div html="<p>A unique name that refers to the remote server node.</p>
<p><strong>Note:</strong></p>
<p>The alias may <strong>only</strong> contain alphanumeric characters, dashes (<code>-</code>), and underscores (<code>_</code>).
It also has a maximum length of 50 characters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A unique name that refers to the remote server node.</p>
<p><strong>Note:</strong></p>
<p>The alias may <strong>only</strong> contain alphanumeric characters, dashes (<code>-</code>), and underscores (<code>_</code>).
It also has a maximum length of 50 characters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="api_token" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">api_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">api_token=23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H</span></div><div><div html="<p>The API token required to make API calls to the remote server node.</p>
<p><strong>Note:</strong></p>
<p>The API token <strong>must</strong> have <code>root</code>-level access on the remote server node.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token required to make API calls to the remote server node.</p>
<p><strong>Note:</strong></p>
<p>The API token <strong>must</strong> have <code>root</code>-level access on the remote server node.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="hostname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">hostname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->hostname<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">hostname=host.example.com</span></div><div><div html="<p>The remote server node&#39;s hostname.</p>
<p><strong>Note:</strong></p>
<p>This parameter does <strong>not</strong> accept an IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server node's hostname.</p>
<p><strong>Note:</strong></p>
<p>This parameter does <strong>not</strong> accept an IP address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="skip_tls_verification" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skip_tls_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">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">skip_tls_verification=0</span></div><div><div html="<p>Whether to skip
<a href="https://docs.cpanel.net/knowledge-base/security/guide-to-ssl/">SSL/TLS verification</a>.
The system performs this action when it queries the remote server node.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip
<a href="https://docs.cpanel.net/knowledge-base/security/guide-to-ssl/">SSL/TLS verification</a>.
The system performs this action when it queries the remote server node.</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=root</span></div><div><div html="<p>The username required to make API calls to the remote server node.</p>
<p><strong>Note:</strong></p>
<p>The username <strong>must</strong> have <code>root</code>-level access on the remote server node.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username required to make API calls to the remote server node.</p>
<p><strong>Note:</strong></p>
<p>The username <strong>must</strong> have <code>root</code>-level access on the remote server node.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/link_server_node_with_api_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/link_server_node_with_api_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:Riimjca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riimjca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riimjca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riimjca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riimjca:0" aria-labelledby="tab:Riimjca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
link_server_node_with_api_token <span class="token punctuation">\</span>
<span class="token assign-left variable">alias</span><span class="token operator">=</span><span class="token string">'example'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">api_token</span><span class="token operator">=</span><span class="token string">'23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">hostname</span><span class="token operator">=</span><span class="token string">'host.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">'root'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riimjca:1" aria-labelledby="tab:Riimjca: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:Rjimjca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjimjca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjimjca:0" aria-labelledby="tab:Rjimjca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"link_server_node_with_api_token"</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/Server-Nodes/operation/unlink_server_node" data-section-id="tag/Server-Nodes/operation/unlink_server_node" class="sc-dntaoT ceciOs"><div data-section-id="operation/unlink_server_node" id="operation/unlink_server_node" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Nodes/operation/unlink_server_node" aria-label="tag/Server-Nodes/operation/unlink_server_node"></a>Remove linked server node<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function unlinks a remote server node from your server.</p>
<p><strong>Important:</strong></p>
<p> This function does <strong>not</strong> unlink mail servers that are currently in use.
You <strong>must</strong> first delete any accounts that use the linked mail server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function unlinks a remote server node from your server.</p>
<p><strong>Important:</strong></p>
<p> This function does <strong>not</strong> unlink mail servers that are currently in use.
You <strong>must</strong> first delete any accounts that use the linked mail 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="alias" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">alias</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">alias=example</span></div><div><div html="<p>The name of a linked remote server node.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of a linked remote server node.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="handle_api_token" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">handle_api_token</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"leave"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"leave"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"expire_24h"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">handle_api_token=expire_24h</span></div><div><div html="<p>What to do with the linkage’s stored API token on the remote server node:</p>
<ul>
<li><code>leave</code>: Leave the API token active.</li>
<li><code>expire_24h</code>: Set the API token to expire after 24 hours. This can be undone.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>What to do with the linkage’s stored API token on the remote server node:</p>
<ul>
<li><code>leave</code>: Leave the API token active.</li>
<li><code>expire_24h</code>: Set the API token to expire after 24 hours. This can be undone.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/unlink_server_node</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/unlink_server_node</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiqjca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiqjca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiqjca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiqjca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiqjca:0" aria-labelledby="tab:Riiqjca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
unlink_server_node <span class="token punctuation">\</span>
<span class="token assign-left variable">alias</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:Riiqjca:1" aria-labelledby="tab:Riiqjca: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:Rjiqjca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiqjca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiqjca:0" aria-labelledby="tab:Rjiqjca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 string">"example"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled_services"</span>: <button class="collapser" aria-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_php_fpm"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hostname"</span>: <span class="token string">"example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_check"</span>: <span class="token number">1556576165</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"system_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">"Mail"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"globalspamassassin"</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">"tls_verified"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"root"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"11.86.0.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"worker_capabilities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"Mail"</span>: <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">"metadata"</span>: <button class="collapser" aria-label="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">"unlink_server_node"</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/Server-Nodes/operation/update_linked_server_node" data-section-id="tag/Server-Nodes/operation/update_linked_server_node" class="sc-dntaoT ceciOs"><div data-section-id="operation/update_linked_server_node" id="operation/update_linked_server_node" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Nodes/operation/update_linked_server_node" aria-label="tag/Server-Nodes/operation/update_linked_server_node"></a>Update linked server node settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function updates a linked remote cPanel server node.</p>
<p><strong>Important:</strong></p>
<p>This function <strong>requires</strong> the use of an API token. For more information,
read our <a href="https://go.cpanel.net/guide-to-api-authentication-api-tokens-in-whm">Guide to API Authentication - API Tokens in WHM</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates a linked remote cPanel server node.</p>
<p><strong>Important:</strong></p>
<p>This function <strong>requires</strong> the use of an API token. For more information,
read our <a href="https://go.cpanel.net/guide-to-api-authentication-api-tokens-in-whm">Guide to API Authentication - API Tokens in WHM</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="alias" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">alias</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">alias=example</span></div><div><div html="<p>The name of a linked remote cPanel server node.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of a linked remote cPanel server node.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="api_token" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">api_token</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">api_token=23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H</span></div><div><div html="<p>The API token required to make API calls to the remote cPanel server node.</p>
<p>This value defaults to the existing API token.</p>
<p><strong>Note:</strong></p>
<p> The API token <strong>must</strong> have <code>root</code>-level access on the remote cPanel server node.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token required to make API calls to the remote cPanel server node.</p>
<p>This value defaults to the existing API token.</p>
<p><strong>Note:</strong></p>
<p> The API token <strong>must</strong> have <code>root</code>-level access on the remote cPanel server node.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="hostname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">hostname</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">hostname=example.com</span></div><div><div html="<p>A new remote cPanel server node&#39;s hostname. The system will update your remote
cPanel server node&#39;s hostname to this value.</p>
<p>This value defaults to the existing hostname.</p>
<p><strong>Note:</strong></p>
<p>This parameter does <strong>not</strong> accept an IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A new remote cPanel server node's hostname. The system will update your remote
cPanel server node's hostname to this value.</p>
<p>This value defaults to the existing hostname.</p>
<p><strong>Note:</strong></p>
<p>This parameter does <strong>not</strong> accept an IP address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="skip_tls_verification" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skip_tls_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">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">skip_tls_verification=0</span></div><div><div html="<p>Whether to skip <a href="https://docs.cpanel.net/knowledge-base/security/guide-to-ssl/">SSL/TLS verification</a>.
The system performs this action when it queries the remote cPanel server node.</p>
<p><strong>Note:</strong></p>
<p>If the remote cPanel server is SSL/TLS verified, you <strong>cannot</strong> skip verification.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip <a href="https://docs.cpanel.net/knowledge-base/security/guide-to-ssl/">SSL/TLS verification</a>.
The system performs this action when it queries the remote cPanel server node.</p>
<p><strong>Note:</strong></p>
<p>If the remote cPanel server is SSL/TLS verified, you <strong>cannot</strong> skip verification.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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=root</span></div><div><div html="<p>The username required to make API calls to the remote cPanel server node.</p>
<p>This value defaults to the existing username.</p>
<p><strong>Note:</strong></p>
<p>The username <strong>must</strong> have <code>root</code>-level access on the remote cPanel server node.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username required to make API calls to the remote cPanel server node.</p>
<p>This value defaults to the existing username.</p>
<p><strong>Note:</strong></p>
<p>The username <strong>must</strong> have <code>root</code>-level access on the remote cPanel server node.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/update_linked_server_node</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/update_linked_server_node</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiujca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiujca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiujca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiujca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiujca:0" aria-labelledby="tab:Riiujca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
update_linked_server_node <span class="token punctuation">\</span>
<span class="token assign-left variable">alias</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:Riiujca:1" aria-labelledby="tab:Riiujca: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:Rjiujca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiujca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiujca:0" aria-labelledby="tab:Rjiujca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"update_linked_server_node"</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/Server-Nodes/operation/force_dedistribution_from_node" data-section-id="tag/Server-Nodes/operation/force_dedistribution_from_node" class="sc-dntaoT ceciOs"><div data-section-id="operation/force_dedistribution_from_node" id="operation/force_dedistribution_from_node" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Nodes/operation/force_dedistribution_from_node" aria-label="tag/Server-Nodes/operation/force_dedistribution_from_node"></a>Repair distributed accounts with data loss<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function converts cPanel accounts that use a given
<a href="https://go.cpanel.net/cPanelGlossary#child-node">child node</a>
to use the local server instead.</p>
<p>Unlike the WHM API 1 <code>modifyacct</code> API call, this API does <strong>not</strong>
transfer users’ data from the child node as part of the conversion.
This API is useful for emergency repairs if, for example, a child
node goes permanently offline while accounts still use it.</p>
<p><strong>Warning:</strong></p>
<p>Because this API does not transfer users’ data from the child node,
all converted users will lose data. You should <strong>only</strong> call this API
as a last resort.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function converts cPanel accounts that use a given
<a href="https://go.cpanel.net/cPanelGlossary#child-node">child node</a>
to use the local server instead.</p>
<p>Unlike the WHM API 1 <code>modifyacct</code> API call, this API does <strong>not</strong>
transfer users’ data from the child node as part of the conversion.
This API is useful for emergency repairs if, for example, a child
node goes permanently offline while accounts still use it.</p>
<p><strong>Warning:</strong></p>
<p>Because this API does not transfer users’ data from the child node,
all converted users will lose data. You should <strong>only</strong> call this API
as a last resort.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="node_alias" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">node_alias</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">node_alias=mailalias</span></div><div><div html="<p>The child node’s alias (friendly name). This is the value passed in the
WHM API 1 <code>link_server_node_with_api_token</code> function’s <code>alias</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The child node’s alias (friendly name). This is the value passed in the
WHM API 1 <code>link_server_node_with_api_token</code> function’s <code>alias</code> parameter.</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">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">user=username&user=username1</span></div><div><div html="<p>The usernames of the
<a href="https://go.cpanel.net/cPanelGlossary#distributed-cpanel-account">distributed cPanel accounts</a>
to convert.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The usernames of the
<a href="https://go.cpanel.net/cPanelGlossary#distributed-cpanel-account">distributed cPanel accounts</a>
to convert.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/force_dedistribution_from_node</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/force_dedistribution_from_node</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij2jca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij2jca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij2jca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij2jca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij2jca:0" aria-labelledby="tab:Rij2jca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
force_dedistribution_from_node <span class="token punctuation">\</span>
<span class="token assign-left variable">node_alias</span><span class="token operator">=</span><span class="token string">'mailalias'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij2jca:1" aria-labelledby="tab:Rij2jca: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:Rjj2jca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj2jca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj2jca:0" aria-labelledby="tab:Rjj2jca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"contents"</span>: <span class="token string">"Converting “username1” …"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"indent"</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">"success"</span></div></li></ul><span class="token punctuation">}</span></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_info"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"username1"</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">"metadata"</span>: <button class="collapser" aria-label="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">"force_dedistribution_from_node"</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/Server-Profiles" data-section-id="tag/Server-Profiles" 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/Server-Profiles" aria-label="tag/Server-Profiles"></a>Server Profiles</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Server Administration / Server Profiles</p>
"><p>Server Administration / Server Profiles</p>
</div></div></div><div id="tag/Server-Profiles/operation/is_role_enabled" data-section-id="tag/Server-Profiles/operation/is_role_enabled" class="sc-dntaoT ceciOs"><div data-section-id="operation/is_role_enabled" id="operation/is_role_enabled" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Profiles/operation/is_role_enabled" aria-label="tag/Server-Profiles/operation/is_role_enabled"></a>Return whether server role is enabled<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks whether a specific server role is currently enabled
for the server.</p>
<p>For more information about server roles, read our <a href="https://go.cpanel.net/serverroles">How to Use Server Profiles</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether a specific server role is currently enabled
for the server.</p>
<p>For more information about server roles, read our <a href="https://go.cpanel.net/serverroles">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="last "><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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"CalendarContact"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"DNS"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"FileStorage"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"FTP"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"MailLocal"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"MailReceive"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"MailRelay"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"MailSend"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"MySQL"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"MySQLClient"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Postgres"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"PostgresClient"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"SpamFilter"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"WebDisk"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"Webmail"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"WebServer"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">role=FTP</span></div><div><div html="<p>The role to check. The role must be one of the following case-sensitive values:</p>
<ul>
<li><p><code>CalendarContact</code> - Allows users to access CalDAV and CardDAV services and features.</p>
</li>
<li><p><code>DNS</code> - Allows users to create and edit Domain Name System (DNS) zone files. This role doesn’t convert your server to a cPanel DNSOnly™ server.</p>
</li>
<li><p><code>FileStorage</code> - Allows users to access cPanel’s <a href="https://go.cpanel.net/cpaneldocsFileManager">File Manager</a> and <a href="https://go.cpanel.net/cpaneldocsasisGitVersionControl">Git™ Version Control</a> features. When a profile disables this role, you can’t enable the Shell Access setting when you create a new cPanel account.</p>
</li>
<li><p><code>FTP</code> - Allows users to manage their account’s files with an FTP client.</p>
</li>
<li><p><code>MailLocal</code> - Allows the control of local mail delivery and related features.</p>
</li>
<li><p><code>MailReceive</code> - Allows users to receive mail from external sources.</p>
</li>
<li><p><code>MailRelay</code> - Allows the server’s Message Transfer Agent (MTA) to forward mail from one remote host to another.</p>
</li>
<li><p><code>MailSend</code> - Allows users to send mail and control the features necessary for sending mail.</p>
</li>
<li><p><code>MySQL</code> - Allows users to create and manage MySQL® or MariaDB databases.</p>
</li>
<li><p><code>MySQLClient</code> - This role checks whether the MySQL/MariaDB client access exists locally or remotely. You cannot directly enable or disable this role. The system enables or disables this role depending on the MySQL configuration.</p>
</li>
<li><p><code>Postgres</code> - Allows users to create and manage <a href="https://go.cpanel.net/whmdocsConfigurePostgreSQL">PostgreSQL</a> databases if cPanel &amp; WHM manages the server’s PostgreSQL.</p>
</li>
<li><p><code>PostgresClient</code> - This role checks whether the PostgreSQL client access exists locally.</p>
</li>
<li><p><code>SpamFilter</code> - Allows users to use Apache SpamAssassin™ to identify, sort, and delete unsolicited mail.</p>
</li>
<li><p><code>WebDisk</code> - Allows users to manage their account’s files with a WebDAV client.</p>
</li>
<li><p><code>Webmail</code> - Allows users to access webmail services and features.</p>
</li>
<li><p><code>WebServer</code> - Allows users to create and manage websites for their domains.</p>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The role to check. The role must be one of the following case-sensitive values:</p>
<ul>
<li><p><code>CalendarContact</code> - Allows users to access CalDAV and CardDAV services and features.</p>
</li>
<li><p><code>DNS</code> - Allows users to create and edit Domain Name System (DNS) zone files. This role doesn’t convert your server to a cPanel DNSOnly™ server.</p>
</li>
<li><p><code>FileStorage</code> - Allows users to access cPanel’s <a href="https://go.cpanel.net/cpaneldocsFileManager">File Manager</a> and <a href="https://go.cpanel.net/cpaneldocsasisGitVersionControl">Git™ Version Control</a> features. When a profile disables this role, you can’t enable the Shell Access setting when you create a new cPanel account.</p>
</li>
<li><p><code>FTP</code> - Allows users to manage their account’s files with an FTP client.</p>
</li>
<li><p><code>MailLocal</code> - Allows the control of local mail delivery and related features.</p>
</li>
<li><p><code>MailReceive</code> - Allows users to receive mail from external sources.</p>
</li>
<li><p><code>MailRelay</code> - Allows the server’s Message Transfer Agent (MTA) to forward mail from one remote host to another.</p>
</li>
<li><p><code>MailSend</code> - Allows users to send mail and control the features necessary for sending mail.</p>
</li>
<li><p><code>MySQL</code> - Allows users to create and manage MySQL® or MariaDB databases.</p>
</li>
<li><p><code>MySQLClient</code> - This role checks whether the MySQL/MariaDB client access exists locally or remotely. You cannot directly enable or disable this role. The system enables or disables this role depending on the MySQL configuration.</p>
</li>
<li><p><code>Postgres</code> - Allows users to create and manage <a href="https://go.cpanel.net/whmdocsConfigurePostgreSQL">PostgreSQL</a> databases if cPanel & WHM manages the server’s PostgreSQL.</p>
</li>
<li><p><code>PostgresClient</code> - This role checks whether the PostgreSQL client access exists locally.</p>
</li>
<li><p><code>SpamFilter</code> - Allows users to use Apache SpamAssassin™ to identify, sort, and delete unsolicited mail.</p>
</li>
<li><p><code>WebDisk</code> - Allows users to manage their account’s files with a WebDAV client.</p>
</li>
<li><p><code>Webmail</code> - Allows users to access webmail services and features.</p>
</li>
<li><p><code>WebServer</code> - Allows users to create and manage websites for their domains.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/is_role_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/is_role_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:R996lca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R996lca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R996lca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R996lca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R996lca:0" aria-labelledby="tab:R996lca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
is_role_enabled <span class="token punctuation">\</span>
<span class="token assign-left variable">role</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:R996lca:1" aria-labelledby="tab:R996lca: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:R9p6lca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p6lca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p6lca:0" aria-labelledby="tab:R9p6lca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"metadata"</span>: <button class="collapser" aria-label="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">"is_role_enabled"</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/Server-Profiles/operation/get_current_profile" data-section-id="tag/Server-Profiles/operation/get_current_profile" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_current_profile" id="operation/get_current_profile" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Profiles/operation/get_current_profile" aria-label="tag/Server-Profiles/operation/get_current_profile"></a>Return server's node profile<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns details about the server&#39;s current
<a href="https://docs.cpanel.net/whm/server-configuration/server-profile/">cPanel &amp; WHM server profile</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns details about the server's current
<a href="https://docs.cpanel.net/whm/server-configuration/server-profile/">cPanel & WHM server profile</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_current_profile</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_current_profile</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99alca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99alca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99alca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99alca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99alca:0" aria-labelledby="tab:R99alca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_current_profile
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99alca:1" aria-labelledby="tab:R99alca: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:R9palca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9palca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9palca:0" aria-labelledby="tab:R9palca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</span>: <span class="token string">"MAILNODE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"This profile provides only services and cPanel features that allow the system to serve mail."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disabled_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 "><button class="collapser" aria-label="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">"FTP allows users to manage the files associated with their site with an FTP client."</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">"name"</span>: <span class="token string">"FTP"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"File Storage allows users to access the File Manager and Git™ Version Control features."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"FileStorage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"File Storage"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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®/MariaDB allows users to create and manage MySQL/MariaDB 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">"name"</span>: <span class="token string">"MySQL/MariaDB"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"PostgreSQL allows users to create and manage PostgreSQL databases."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgres"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"PostgreSQL"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Web Disk allows users to manage and manipulate files on the server with multiple types of devices."</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">"name"</span>: <span class="token string">"Web Disk"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Web Server allows users to create and manage websites for their domains."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WebServer"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Web 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">"enabled_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 "><button class="collapser" aria-label="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">"Calendars and Contacts provides CalDAV and CardDAV services."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CalendarContact"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Calendars and Contacts"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Receive Mail allows users to receive email, as well as create and manage their email accounts."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"MailReceive"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Receive Mail"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Send Mail allows users to send email."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"MailSend"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Send Mail"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Local Mail allows the system to process email."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"MailLocal"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Local Mail"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Webmail provides access to webmail services."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Webmail"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Webmail"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"experimental"</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">"Mail"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"optional_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 "><button class="collapser" aria-label="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">"DNS allows users to create and edit Domain Name System zone files."</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">"name"</span>: <span class="token string">"DNS"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Spam Filter allows users to use Apache SpamAssassin™ to identify, sort, and delete unsolicited mail."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SpamFilter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Spam Filter"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_current_profile"</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/Server-Profiles/operation/get_available_profiles" data-section-id="tag/Server-Profiles/operation/get_available_profiles" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_available_profiles" id="operation/get_available_profiles" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Profiles/operation/get_available_profiles" aria-label="tag/Server-Profiles/operation/get_available_profiles"></a>Return available server profiles<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a list of available server profiles.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of available server profiles.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_available_profiles</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_available_profiles</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99elca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99elca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99elca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99elca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99elca:0" aria-labelledby="tab:R99elca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_available_profiles
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99elca:1" aria-labelledby="tab:R99elca: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:R9pelca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pelca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pelca:0" aria-labelledby="tab:R9pelca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"profiles"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</span>: <span class="token string">"STANDARD"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"The Standard Node profile provides all services and access to every cPanel feature."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled_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 "><button class="collapser" aria-label="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">"Calendars and Contacts provides CalDAV and CardDAV services."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"CalendarContact"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Calendars and Contacts"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"DNS allows users to create and edit Domain Name System zone files."</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">"name"</span>: <span class="token string">"DNS"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"FTP allows users to manage the files associated with their site with an FTP client."</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">"name"</span>: <span class="token string">"FTP"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"File Storage allows users to access the File Manager and Git™ Version Control features."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"FileStorage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"File Storage"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Receive Mail allows users to receive email, as well as create and manage their email accounts."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"MailReceive"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Receive Mail"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Send Mail allows users to send email."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"MailSend"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Send Mail"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Local Mail allows the system to process email."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"MailLocal"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Local Mail"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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®/MariaDB allows users to create and manage MySQL/MariaDB 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">"name"</span>: <span class="token string">"MySQL/MariaDB"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"PostgreSQL allows users to create and manage PostgreSQL databases."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Postgres"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"PostgreSQL"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Spam Filter allows users to use Apache SpamAssassin™ to identify, sort, and delete unsolicited mail."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"SpamFilter"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Spam Filter"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Webmail provides access to webmail services."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"Webmail"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Webmail"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Web Disk allows users to manage and manipulate files on the server with multiple types of devices."</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">"name"</span>: <span class="token string">"Web Disk"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Web Server allows users to create and manage websites for their domains."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">"WebServer"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Web 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">"experimental"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="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">"get_available_profiles"</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/Server-Profiles/operation/start_profile_activation" data-section-id="tag/Server-Profiles/operation/start_profile_activation" class="sc-dntaoT ceciOs"><div data-section-id="operation/start_profile_activation" id="operation/start_profile_activation" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Profiles/operation/start_profile_activation" aria-label="tag/Server-Profiles/operation/start_profile_activation"></a>Update server node profile<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function activates a server profile.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If a server profile enables a service, the system will <strong>also</strong> enable service monitoring. To disable a service&#39;s monitoring, use WHM&#39;s <a href="https://docs.cpanel.net/whm/service-configuration/service-manager/"><em>Service Manager</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Service Configuration &gt;&gt; Service Manager</em>).</li>
<li>For a list of the server&#39;s available profiles, use the <code>get_available_profiles</code> function.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function activates a server profile.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If a server profile enables a service, the system will <strong>also</strong> enable service monitoring. To disable a service's monitoring, use WHM's <a href="https://docs.cpanel.net/whm/service-configuration/service-manager/"><em>Service Manager</em></a> interface (<em>WHM >> Home >> Service Configuration >> Service Manager</em>).</li>
<li>For a list of the server's available profiles, use the <code>get_available_profiles</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="code" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">code</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"DATABASENODE"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"MAILNODE"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"DNSNODE"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">code=MAILNODE</span></div><div><div html="<p>The code value of the server profile.</p>
<ul>
<li><code>STANDARD</code> — The Standard profile.</li>
<li><code>DATABASENODE</code> — The Database profile.</li>
<li><code>MAILNODE</code> — The Mail profile.</li>
<li><code>DNSNODE</code> — The DNS profile.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The code value of the server profile.</p>
<ul>
<li><code>STANDARD</code> — The Standard profile.</li>
<li><code>DATABASENODE</code> — The Database profile.</li>
<li><code>MAILNODE</code> — The Mail profile.</li>
<li><code>DNSNODE</code> — The DNS profile.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="optional" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand optional"><span class="property-name">optional</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl 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">optional={"DNS":0,"SpamFilter":1}</span></div><div><div html="<p>The optional roles to enable or disable with the profile, in
JSON format. You <strong>must</strong> URI-encode this value.</p>
<p><strong>Note:</strong></p>
<ul>
<li><p>As an example, if you wished to enable <code>SpamFilter</code> and disable <code>DNS</code>, the JSON object would be:</p>
<p> <code>{ &quot;SpamFilter&quot;: 1, &quot;DNS&quot;: 0 }</code>.</p>
</li>
<li><p>This parameter does <strong>not</strong> enable optional roles for profiles that do <strong>not</strong> possess any optional roles.</p>
</li>
<li><p>If you do not pass this parameter, the system <strong>disables</strong> a profile&#39;s optional roles, if any exist.</p>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The optional roles to enable or disable with the profile, in
JSON format. You <strong>must</strong> URI-encode this value.</p>
<p><strong>Note:</strong></p>
<ul>
<li><p>As an example, if you wished to enable <code>SpamFilter</code> and disable <code>DNS</code>, the JSON object would be:</p>
<p> <code>{ "SpamFilter": 1, "DNS": 0 }</code>.</p>
</li>
<li><p>This parameter does <strong>not</strong> enable optional roles for profiles that do <strong>not</strong> possess any optional roles.</p>
</li>
<li><p>If you do not pass this parameter, the system <strong>disables</strong> a profile's optional roles, if any exist.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/start_profile_activation</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/start_profile_activation</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99ilca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ilca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ilca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ilca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ilca:0" aria-labelledby="tab:R99ilca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
start_profile_activation <span class="token punctuation">\</span>
<span class="token assign-left variable">code</span><span class="token operator">=</span><span class="token string">'MAILNODE'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ilca:1" aria-labelledby="tab:R99ilca: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:R9pilca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pilca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pilca:0" aria-labelledby="tab:R9pilca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"17053.10418168.1533478604"</span></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">"command"</span>: <span class="token string">"start_profile_activation"</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/Services" data-section-id="tag/Services" 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/Services" aria-label="tag/Services"></a>Services</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Server Administration / Services</p>
"><p>Server Administration / Services</p>
</div></div></div><div id="tag/Services/operation/get_service_config_key" data-section-id="tag/Services/operation/get_service_config_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_service_config_key" id="operation/get_service_config_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Services/operation/get_service_config_key" aria-label="tag/Services/operation/get_service_config_key"></a>Return service configuration key<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a specific configuration key for a service.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a specific configuration key 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="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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=mail_process_size</span></div><div><div html="<p>The configuration key&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The configuration key's name.</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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service=dovecot</span></div><div><div html="<p>The service&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_service_config_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_service_config_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:Rii6nca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii6nca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii6nca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii6nca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii6nca:0" aria-labelledby="tab:Rii6nca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_service_config_key <span class="token punctuation">\</span>
<span class="token assign-left variable">service</span><span class="token operator">=</span><span class="token string">'dovecot'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">key</span><span class="token operator">=</span><span class="token string">'mail_process_size'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii6nca:1" aria-labelledby="tab:Rii6nca: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:Rji6nca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji6nca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji6nca:0" aria-labelledby="tab:Rji6nca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 name"</span>: <span class="token string">"512"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mail_process_size"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_service_config_key"</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/Services/operation/set_service_config_key" data-section-id="tag/Services/operation/set_service_config_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_service_config_key" id="operation/set_service_config_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Services/operation/set_service_config_key" aria-label="tag/Services/operation/set_service_config_key"></a>Update service configuration key<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function configures global properties for specific services listed in the <code>/var/cpanel/conf</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function configures global properties for specific services listed in the <code>/var/cpanel/conf</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=""><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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=mail_process_size</span></div><div><div html="<p>The configuration key&#39;s name.</p>
<ul>
<li>This parameter uses the key names listed in the <code>/var/cpanel/conf/{service}/main</code> file, where {service} is the service&#39;s name from the service parameter.</li>
<li>This function does not support subkeys.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The configuration key's name.</p>
<ul>
<li>This parameter uses the key names listed in the <code>/var/cpanel/conf/{service}/main</code> file, where {service} is the service's name from the service parameter.</li>
<li>This function does not support subkeys.</li>
</ul>
</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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service=dovecot</span></div><div><div html="<p>The service&#39;s name.</p>
<ul>
<li>A list of service names exists in the <code>/var/cpanel/conf</code> directory.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service's name.</p>
<ul>
<li>A list of service names exists in the <code>/var/cpanel/conf</code> directory.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="value" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand value"><span class="property-name">value</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">value=512</span></div><div><div html="<p>The new value for the configuration key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new value for the configuration 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="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">/set_service_config_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_service_config_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:Riianca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riianca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riianca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riianca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riianca:0" aria-labelledby="tab:Riianca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_service_config_key <span class="token punctuation">\</span>
<span class="token assign-left variable">service</span><span class="token operator">=</span><span class="token string">'dovecot'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">key</span><span class="token operator">=</span><span class="token string">'mail_process_size'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">value</span><span class="token operator">=</span><span class="token string">'512'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riianca:1" aria-labelledby="tab:Riianca: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:Rjianca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjianca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjianca:0" aria-labelledby="tab:Rjianca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_service_config_key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Succeeded"</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/Services/operation/set_service_proxy_backends" data-section-id="tag/Services/operation/set_service_proxy_backends" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_service_proxy_backends" id="operation/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/Services/operation/set_service_proxy_backends" aria-label="tag/Services/operation/set_service_proxy_backends"></a>Update 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 cPanel account is a <a href="https://go.cpanel.net/cPanelGlossary#distributed-cpanel-account">distributed account</a>,
and you call this function on the account’s <a href="https://go.cpanel.net/cPanelGlossary#parent-node">parent node</a>,
the system will propagate the new service proxying to the <a href="https://go.cpanel.net/cPanelGlossary#child-node">child node</a>.</li>
<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 WHM API 1 <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 cPanel account is a <a href="https://go.cpanel.net/cPanelGlossary#distributed-cpanel-account">distributed account</a>,
and you call this function on the account’s <a href="https://go.cpanel.net/cPanelGlossary#parent-node">parent node</a>,
the system will propagate the new service proxying to the <a href="https://go.cpanel.net/cPanelGlossary#child-node">child node</a>.</li>
<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 WHM API 1 <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=service-group-0=Mail&service-group-1=Mail&service-group-3=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 <code>multiple service_group</code> values, increment the parameter name. For example,
<code>service_group-1</code>, <code>service_group-2</code>, and <code>service_group-3</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 <code>multiple service_group</code> values, increment the parameter name. For example,
<code>service_group-1</code>, <code>service_group-2</code>, and <code>service_group-3</code>.</li>
</ul>
</div></div></div></td></tr><tr class=""><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=service_group_backend-1=mail.example1.com&service_group_backend-2=mail.example2.com&service_group_backend-3=mail.example3.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-1</code>, <code>service_group_backend-2</code>,
and <code>service_group_backend-3</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-1</code>, <code>service_group_backend-2</code>,
and <code>service_group_backend-3</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 cPanel account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:Riienca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riienca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riienca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riienca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riienca:0" aria-labelledby="tab:Riienca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_service_proxy_backends <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:Riienca:1" aria-labelledby="tab:Riienca: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:Rjienca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjienca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjienca:0" aria-labelledby="tab:Rjienca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_service_proxy_backends"</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/Services/operation/servicestatus" data-section-id="tag/Services/operation/servicestatus" class="sc-dntaoT ceciOs"><div data-section-id="operation/servicestatus" id="operation/servicestatus" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Services/operation/servicestatus" aria-label="tag/Services/operation/servicestatus"></a>Return service status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function reports which services (daemons) are enabled, installed, and monitored on your server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function reports which services (daemons) are enabled, installed, and monitored 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><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service=crond</span></div><div><div html="<p>The service for which to view the status.</p>
<p><strong>Notes</strong></p>
<p>If you do <strong>not</strong> specify this parameter, the function will return the status for all of your server&#39;s services.</p>
<p>Available Services:</p>
<ul>
<li>apache_php_fpm</li>
<li>clamd</li>
<li>cpanel-dovecot-solr</li>
<li>cpanel_php_fpm</li>
<li>cpanellogd</li>
<li>cpdavd</li>
<li>cpgreylistd</li>
<li>cphulkd</li>
<li>cpsrvd</li>
<li>crond</li>
<li>dnsadmin</li>
<li>exim</li>
<li>exim-altport</li>
<li>ftpd</li>
<li>httpd</li>
<li>imap</li>
<li>ipaliases</li>
<li>lmtp</li>
<li>mailman</li>
<li>mysql</li>
<li>named</li>
<li>nscd</li>
<li>p0f</li>
<li>pop</li>
<li>postgresql</li>
<li>queueprocd</li>
<li>rsyslogd</li>
<li>spamd</li>
<li>sshd</li>
<li>syslogd</li>
<li>tailwatchd</li>
</ul>
<p>For more information about these services, read our <a href="https://go.cpanel.net/whmdocsServiceManager">Service Manager</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service for which to view the status.</p>
<p><strong>Notes</strong></p>
<p>If you do <strong>not</strong> specify this parameter, the function will return the status for all of your server's services.</p>
<p>Available Services:</p>
<ul>
<li>apache_php_fpm</li>
<li>clamd</li>
<li>cpanel-dovecot-solr</li>
<li>cpanel_php_fpm</li>
<li>cpanellogd</li>
<li>cpdavd</li>
<li>cpgreylistd</li>
<li>cphulkd</li>
<li>cpsrvd</li>
<li>crond</li>
<li>dnsadmin</li>
<li>exim</li>
<li>exim-altport</li>
<li>ftpd</li>
<li>httpd</li>
<li>imap</li>
<li>ipaliases</li>
<li>lmtp</li>
<li>mailman</li>
<li>mysql</li>
<li>named</li>
<li>nscd</li>
<li>p0f</li>
<li>pop</li>
<li>postgresql</li>
<li>queueprocd</li>
<li>rsyslogd</li>
<li>spamd</li>
<li>sshd</li>
<li>syslogd</li>
<li>tailwatchd</li>
</ul>
<p>For more information about these services, read our <a href="https://go.cpanel.net/whmdocsServiceManager">Service Manager</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/servicestatus</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/servicestatus</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiinca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiinca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiinca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiinca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiinca:0" aria-labelledby="tab:Riiinca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
servicestatus
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiinca:1" aria-labelledby="tab:Riiinca: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:Rjiinca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiinca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiinca:0" aria-labelledby="tab:Rjiinca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"service"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"Cron Daemon"</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">"installed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"monitored"</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">"crond"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"running"</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">"metadata"</span>: <button class="collapser" aria-label="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">"servicestatus"</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/Services/operation/enable_monitor_all_enabled_services" data-section-id="tag/Services/operation/enable_monitor_all_enabled_services" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_monitor_all_enabled_services" id="operation/enable_monitor_all_enabled_services" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Services/operation/enable_monitor_all_enabled_services" aria-label="tag/Services/operation/enable_monitor_all_enabled_services"></a>Enable monitoring for all services<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables monitoring for all enabled services.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables monitoring for all enabled services.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/enable_monitor_all_enabled_services</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/enable_monitor_all_enabled_services</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riimnca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riimnca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riimnca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riimnca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riimnca:0" aria-labelledby="tab:Riimnca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
enable_monitor_all_enabled_services
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riimnca:1" aria-labelledby="tab:Riimnca: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:Rjimnca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjimnca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjimnca:0" aria-labelledby="tab:Rjimnca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"monitored"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"cphulkd"</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">"metadata"</span>: <button class="collapser" aria-label="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">"enable_monitor_all_enabled_services"</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/Services/operation/configureservice" data-section-id="tag/Services/operation/configureservice" class="sc-dntaoT ceciOs"><div data-section-id="operation/configureservice" id="operation/configureservice" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Services/operation/configureservice" aria-label="tag/Services/operation/configureservice"></a>Enable or disable a service and its monitoring<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables or disables a service and its monitoring.</p>
<p><strong>Note:</strong></p>
<p>If the user only possesses the <code>clustering</code>
<a href="https://go.cpanel.net/ACLReferenceChart">Access Control List (ACL)</a>,
then this function can only act on the <code>named</code> service.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables or disables a service and its monitoring.</p>
<p><strong>Note:</strong></p>
<p>If the user only possesses the <code>clustering</code>
<a href="https://go.cpanel.net/ACLReferenceChart">Access Control List (ACL)</a>,
then this function can only act on the <code>named</code> 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="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"> <!-- -->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 service.</p>
<ul>
<li><code>1</code> — Enable.</li>
<li><code>0</code> — Disable.</li>
</ul>
<p>If you do not use this parameter, the function will <strong>not</strong> change
the enabled status of the service.</p>
<p><strong>Warning:</strong></p>
<p>Do <strong>not</strong> use this function to disable the <code>cpsrvd</code> service.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable the service.</p>
<ul>
<li><code>1</code> — Enable.</li>
<li><code>0</code> — Disable.</li>
</ul>
<p>If you do not use this parameter, the function will <strong>not</strong> change
the enabled status of the service.</p>
<p><strong>Warning:</strong></p>
<p>Do <strong>not</strong> use this function to disable the <code>cpsrvd</code> service.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="exim-altportnum" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">exim-altportnum</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">26</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">exim-altportnum=26, 5000, 6000</span></div><div><div html="<p>A port or list of comma-separated ports on which Exim will listen for
inbound connections.</p>
<p><strong>Note:</strong></p>
<p>The function <strong>only</strong> uses this parameter if you set <code>exim-altport</code> as
the <code>service</code> parameter&#39;s value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A port or list of comma-separated ports on which Exim will listen for
inbound connections.</p>
<p><strong>Note:</strong></p>
<p>The function <strong>only</strong> uses this parameter if you set <code>exim-altport</code> as
the <code>service</code> parameter's value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="monitored" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">monitored</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">monitored=1</span></div><div><div html="<p>Whether to monitor the service in WHM&#39;s
<a href="https://docs.cpanel.net/whm/server-status/service-status/"><em>Service Status</em></a>
interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Status &gt;&gt; Service Status</em>).</p>
<ul>
<li><code>1</code> — Monitor.</li>
<li><code>0</code> — Do <strong>not</strong> monitor.</li>
</ul>
<p>If you do not use this parameter, the function will <strong>not</strong> change the
monitoring status of the service.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to monitor the service in WHM's
<a href="https://docs.cpanel.net/whm/server-status/service-status/"><em>Service Status</em></a>
interface (<em>WHM >> Home >> Server Status >> Service Status</em>).</p>
<ul>
<li><code>1</code> — Monitor.</li>
<li><code>0</code> — Do <strong>not</strong> monitor.</li>
</ul>
<p>If you do not use this parameter, the function will <strong>not</strong> change the
monitoring status of the service.</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">"apache_php_fpm"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpanel-dovecot-solr"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpanel_php_fpm"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpanellogd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpdavd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cphulkd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpsrvd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"crond"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"dnsadmin"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"exim"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"exim-altport"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ftpd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"httpd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"imap"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ipaliases"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"lmtp"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mailman"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"mysql"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"named"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"nscd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"p0f"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"pop"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"postgresql"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"queueprocd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"rsyslogd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"spamd"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"sshd"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service=mysql</span></div><div><div html="<p>The service to configure. For more information about each service, read our
<a href="https://go.cpanel.net/whmdocsServiceManager"><em>Service Manager</em></a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service to configure. For more information about each service, read our
<a href="https://go.cpanel.net/whmdocsServiceManager"><em>Service Manager</em></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="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">/configureservice</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/configureservice</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiqnca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiqnca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiqnca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiqnca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiqnca:0" aria-labelledby="tab:Riiqnca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
configureservice <span class="token punctuation">\</span>
<span class="token assign-left variable">service</span><span class="token operator">=</span><span class="token string">'mysql'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiqnca:1" aria-labelledby="tab:Riiqnca: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:Rjiqnca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiqnca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiqnca:0" aria-labelledby="tab:Rjiqnca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"configureservice"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Enabled monitoring for mysql."</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/Services/operation/restartservice" data-section-id="tag/Services/operation/restartservice" class="sc-dntaoT ceciOs"><div data-section-id="operation/restartservice" id="operation/restartservice" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Services/operation/restartservice" aria-label="tag/Services/operation/restartservice"></a>Restart service<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function restarts a service, or daemon, on a server.</p>
<p><strong>Note:</strong></p>
<p>If the user <strong>only</strong> possesses the <code>clustering</code>
<a href="https://go.cpanel.net/ACLReferenceChart">Access Control List (ACL)</a>
then this function can <strong>only</strong> act on the <code>named</code> service.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restarts a service, or daemon, on a server.</p>
<p><strong>Note:</strong></p>
<p>If the user <strong>only</strong> possesses the <code>clustering</code>
<a href="https://go.cpanel.net/ACLReferenceChart">Access Control List (ACL)</a>
then this function can <strong>only</strong> act on the <code>named</code> 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="queue_task" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">queue_task</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">queue_task=0</span></div><div><div html="<p>Whether to queue this task.</p>
<ul>
<li><code>1</code> — Queue.</li>
<li><code>0</code> — Do <strong>not</strong> queue.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter affects the <code>output</code> return.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to queue this task.</p>
<ul>
<li><code>1</code> — Queue.</li>
<li><code>0</code> — Do <strong>not</strong> queue.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter affects the <code>output</code> return.</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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service=exim</span></div><div><div html="<p>The service to restart. For a list of possible values, read our
<a href="https://go.cpanel.net/ACLReferenceChart">Access Control List (ACL)</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service to restart. For a list of possible values, read our
<a href="https://go.cpanel.net/ACLReferenceChart">Access Control List (ACL)</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/restartservice</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/restartservice</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiunca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiunca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiunca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiunca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiunca:0" aria-labelledby="tab:Riiunca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
restartservice <span class="token punctuation">\</span>
<span class="token assign-left variable">service</span><span class="token operator">=</span><span class="token string">'exim'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiunca:1" aria-labelledby="tab:Riiunca: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:Rjiunca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiunca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiunca:0" aria-labelledby="tab:Rjiunca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"output"</span>: <span class="token string">"Waiting for httpd to restart..............finished.\\n\\nhttpd (/usr/local/apache/bin/httpd -k start -DSSL) running as root with PID 21379\\nhttpd (/usr/local/apache/bin/httpd -k start -DSSL) running as root with PID 21385\\n\\nhttpd started ok\\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"exim"</span></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">"command"</span>: <span class="token string">"restartservice"</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/Services/operation/configurebackgroundprocesskiller" data-section-id="tag/Services/operation/configurebackgroundprocesskiller" class="sc-dntaoT ceciOs"><div data-section-id="operation/configurebackgroundprocesskiller" id="operation/configurebackgroundprocesskiller" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Services/operation/configurebackgroundprocesskiller" aria-label="tag/Services/operation/configurebackgroundprocesskiller"></a>Update background process stopper<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function configures the server&#39;s background process killer.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function configures the server's background process killer.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="processes_to_kill" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">processes_to_kill</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-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">processes_to_kill=eggdrop-0, eggdrop-1, eggdrop-2</span> -<!-- --> <!-- -->Kill multiple processes.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">processes_to_kill=eggdrop</span> -<!-- --> <!-- -->Kill a single process.</li></ul><div><div html="<p>A process to kill in the <code>/usr/local/cpanel/etc/sym</code> directory.</p>
<p><strong>Note:</strong></p>
<p>To enable the background killer for multiple processes, duplicate or increment the parameter name.</p>
<p>For example, <code>processes_to_kill</code>, <code>processes_to_kill-0</code>, and <code>processes_to_kill-1</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A process to kill in the <code>/usr/local/cpanel/etc/sym</code> directory.</p>
<p><strong>Note:</strong></p>
<p>To enable the background killer for multiple processes, duplicate or increment the parameter name.</p>
<p>For example, <code>processes_to_kill</code>, <code>processes_to_kill-0</code>, and <code>processes_to_kill-1</code>.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="trusted_users" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">trusted_users</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">trusted_users=user</span></div><div><div html="<p>Unaffected users. If you do not specify a value, the function affects all of the users on the server.</p>
<p><strong>Note:</strong></p>
<p>To trust multiple users, duplicate or increment the parameter name.</p>
<p>For example, <code>trusted_users</code>, <code>trusted_users-0</code>, and <code>trusted_users-1</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Unaffected users. If you do not specify a value, the function affects all of the users on the server.</p>
<p><strong>Note:</strong></p>
<p>To trust multiple users, duplicate or increment the parameter name.</p>
<p>For example, <code>trusted_users</code>, <code>trusted_users-0</code>, and <code>trusted_users-1</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="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">/configurebackgroundprocesskiller</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/configurebackgroundprocesskiller</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij2nca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij2nca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij2nca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij2nca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij2nca:0" aria-labelledby="tab:Rij2nca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
configurebackgroundprocesskiller <span class="token punctuation">\</span>
<span class="token assign-left variable">processes_to_kill</span><span class="token operator">=</span><span class="token string">'eggdrop'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij2nca:1" aria-labelledby="tab:Rij2nca: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:Rjj2nca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj2nca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj2nca:0" aria-labelledby="tab:Rjj2nca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"configurebackgroundprocesskiller"</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/Services/operation/unset_all_service_proxy_backends" data-section-id="tag/Services/operation/unset_all_service_proxy_backends" class="sc-dntaoT ceciOs"><div data-section-id="operation/unset_all_service_proxy_backends" id="operation/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/Services/operation/unset_all_service_proxy_backends" aria-label="tag/Services/operation/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 cPanel account is a <a href="https://go.cpanel.net/cPanelGlossary#distributed-cpanel-account">distributed account</a>,
this function will also unset <strong>all</strong> service proxying for the cPanel account on the
<a href="https://go.cpanel.net/cPanelGlossary#child-node">child node</a>.</li>
<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 WHM API 1
<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 cPanel account is a <a href="https://go.cpanel.net/cPanelGlossary#distributed-cpanel-account">distributed account</a>,
this function will also unset <strong>all</strong> service proxying for the cPanel account on the
<a href="https://go.cpanel.net/cPanelGlossary#child-node">child node</a>.</li>
<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 WHM API 1
<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><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><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=username</span></div><div><div html="<p>The cPanel account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:Rij6nca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij6nca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij6nca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij6nca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij6nca:0" aria-labelledby="tab:Rij6nca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
unset_all_service_proxy_backends <span class="token punctuation">\</span>
<span class="token assign-left variable">username</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:Rij6nca:1" aria-labelledby="tab:Rij6nca: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:Rjj6nca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj6nca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj6nca:0" aria-labelledby="tab:Rjj6nca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"unset_all_service_proxy_backends"</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/Services/operation/get_service_proxy_backends" data-section-id="tag/Services/operation/get_service_proxy_backends" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_service_proxy_backends" id="operation/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/Services/operation/get_service_proxy_backends" aria-label="tag/Services/operation/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><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><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 cPanel account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:Rijanca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijanca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijanca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijanca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijanca:0" aria-labelledby="tab:Rijanca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_service_proxy_backends <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:Rijanca:1" aria-labelledby="tab:Rijanca: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:Rjjanca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjanca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjanca:0" aria-labelledby="tab:Rjjanca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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></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">"command"</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">"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/Services/operation/get_service_config" data-section-id="tag/Services/operation/get_service_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_service_config" id="operation/get_service_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Services/operation/get_service_config" aria-label="tag/Services/operation/get_service_config"></a>Return service configuration settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a service&#39;s configuration settings.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a service's 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="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"> <!-- -->Value<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"dovecot"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service=dovecot</span></div><div><div html="<p>The service&#39;s name.</p>
<ul>
<li><code>dovecot</code> — The Dovecot service.</li>
</ul>
<p><strong>Note:</strong></p>
<p>For a fresh install, the data returned for the Dovecot
service will only contain the list of protocols. It will
not be until the mailserver configuration is saved that
the return data for Dovecot will look like what is shown
in the example.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service's name.</p>
<ul>
<li><code>dovecot</code> — The Dovecot service.</li>
</ul>
<p><strong>Note:</strong></p>
<p>For a fresh install, the data returned for the Dovecot
service will only contain the list of protocols. It will
not be until the mailserver configuration is saved that
the return data for Dovecot will look like what is shown
in the example.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><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>A list of the configuration key&#39;s settings.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of the configuration key's settings.</p>
</div></div></div></td></tr><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">/get_service_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_service_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:Rijenca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijenca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijenca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijenca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijenca:0" aria-labelledby="tab:Rijenca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_service_config <span class="token punctuation">\</span>
<span class="token assign-left variable">service</span><span class="token operator">=</span><span class="token string">'dovecot'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijenca:1" aria-labelledby="tab:Rijenca: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:Rjjenca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjenca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjenca:0" aria-labelledby="tab:Rjjenca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_cache_negative_ttl"</span>: <span class="token number">3600</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_cache_size"</span>: <span class="token string">"1M"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_cache_ttl"</span>: <span class="token number">3600</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_policy_hash_nonce"</span>: <span class="token number">91057590</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"compress_messages"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"config_vsz_limit"</span>: <span class="token number">2048</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disable_plaintext_auth"</span>: <span class="token string">"no"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expire_trash"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expire_spam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hulk_auth_passwd"</span>: <span class="token string">"FAMONex4Bn9Hv1BO"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"include_trash_in_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"incoming_reached_quota"</span>: <span class="token string">"bounce"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ipv6"</span>: <span class="token string">"on"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lmtp_process_limit"</span>: <span class="token number">500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lmtp_process_min_avail"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lmtp_user_concurrency_limit"</span>: <span class="token number">4</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login_max_processes_count"</span>: <span class="token number">50</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login_process_per_connection"</span>: <span class="token string">"no"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login_process_size"</span>: <span class="token number">128</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login_processes_count"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mail_process_size"</span>: <span class="token number">512</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mdbox_rotate_interval"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mdbox_rotate_size"</span>: <span class="token string">"10M"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"protocol_imap"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"mail_max_userip_connections"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"map_idle_notify_interval"</span>: <span class="token number">24</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"protocol_pop3"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"mail_max_userip_connections"</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">"protocols"</span>: <span class="token string">"imap pop3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssl_cipher_list"</span>: <span class="token string">"ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssl_min_protocol"</span>: <span class="token string">"TLSv1.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">"metadata"</span>: <button class="collapser" aria-label="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">"get_service_config"</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/System-Information" data-section-id="tag/System-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/System-Information" aria-label="tag/System-Information"></a>System Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>The Server Administration module for WHM API 1.</p>
"><p>The Server Administration module for WHM API 1.</p>
</div></div></div><div id="tag/System-Information/operation/system_needs_reboot" data-section-id="tag/System-Information/operation/system_needs_reboot" class="sc-dntaoT ceciOs"><div data-section-id="operation/system_needs_reboot" id="operation/system_needs_reboot" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/System-Information/operation/system_needs_reboot" aria-label="tag/System-Information/operation/system_needs_reboot"></a>Return whether system needs reboot<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function determines if your system requires a reboot to apply quotas, software package updates, or kernel updates.</p>
<p><strong>Important:</strong></p>
<p>This function <strong>cannot</strong> detect whether your system needs a reboot if you use cPanel &amp; WHM inside of a <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/linux-containers/">Linux Container (LXC)</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function determines if your system requires a reboot to apply quotas, software package updates, or kernel updates.</p>
<p><strong>Important:</strong></p>
<p>This function <strong>cannot</strong> detect whether your system needs a reboot if you use cPanel & WHM inside of a <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/linux-containers/">Linux Container (LXC)</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="details" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand details"><span class="property-name">details</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><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>An object that contains reasons why the system requires a reboot.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An object that contains reasons why the system requires a reboot.</p>
</div></div></div></td></tr><tr class=""><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><tr class="last "><td kind="field" title="needs_reboot" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">needs_reboot</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether the system requires a reboot.</p>
<ul>
<li><code>1</code> — System requires a reboot.</li>
<li><code>0</code> — System does <strong>not</strong> require a reboot.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the system requires a reboot.</p>
<ul>
<li><code>1</code> — System requires a reboot.</li>
<li><code>0</code> — System does <strong>not</strong> require a reboot.</li>
</ul>
</div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/system_needs_reboot</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/system_needs_reboot</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R996pca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R996pca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R996pca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R996pca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R996pca:0" aria-labelledby="tab:R996pca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
system_needs_reboot
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996pca:1" aria-labelledby="tab:R996pca: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:R9p6pca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p6pca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p6pca:0" aria-labelledby="tab:R9p6pca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"kernel"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"boot_version"</span>: <span class="token string">"3.10.0-514.10.2.e17.x86_64"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"running_version"</span>: <span class="token string">"3.10.0-514.10.2.e17.x86_64"</span></div></li></ul><span class="token punctuation">}</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"glibc"</span>: <span class="token string">"2.17-157.el7_3.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">"metadata"</span>: <button class="collapser" aria-label="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">"system_needs_reboot"</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"needs_reboot"</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/System-Information/operation/systemloadavg" data-section-id="tag/System-Information/operation/systemloadavg" class="sc-dntaoT ceciOs"><div data-section-id="operation/systemloadavg" id="operation/systemloadavg" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/System-Information/operation/systemloadavg" aria-label="tag/System-Information/operation/systemloadavg"></a>Return system load average<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the system&#39;s load average.</p>
<p><strong>Note:</strong></p>
<p>The values the function returns represent a percentage of the CPU&#39;s processor capacity.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the system's load average.</p>
<p><strong>Note:</strong></p>
<p>The values the function returns represent a percentage of the CPU's processor capacity.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/systemloadavg</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/systemloadavg</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99apca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99apca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99apca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99apca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99apca:0" aria-labelledby="tab:R99apca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
systemloadavg
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99apca:1" aria-labelledby="tab:R99apca: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:R9papca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9papca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9papca:0" aria-labelledby="tab:R9papca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fifteen"</span>: <span class="token number">0.19</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"five"</span>: <span class="token number">0.18</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"one"</span>: <span class="token number">0.17</span></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">"command"</span>: <span class="token string">"systemloadavg"</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/System-Information/operation/sethostname" data-section-id="tag/System-Information/operation/sethostname" class="sc-dntaoT ceciOs"><div data-section-id="operation/sethostname" id="operation/sethostname" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/System-Information/operation/sethostname" aria-label="tag/System-Information/operation/sethostname"></a>Update server's hostname<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function changes the server&#39;s hostname.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>Do <strong>not</strong> select a hostname that begins with <code>www</code> or a number, or a
hostname that ends with a hyphen (<code>-</code>) character.</li>
<li>You <strong>must</strong> use a fully-qualified domain name (FQDN) that contains two periods
(for example, <code>hostname.example.com</code>).</li>
<li>Do <strong>not</strong> choose a hostname that a cPanel account on your server will use.</li>
<li>Do <strong>not</strong> choose a potential service subdomain (proxy subdomain) as a hostname
(for example, <code>cpanel.example.com</code> or <code>whm.example.com</code>).</li>
</ul>
<p><strong>Important:</strong></p>
<p>If you update your hostname, the system blocks user access to cPanel&#39;s <a href="https://go.cpanel.net/calendars"><em>Calendars and Contacts</em></a> interface (<em>cPanel &gt;&gt; Home &gt;&gt; Email &gt;&gt; Calendars and Contacts</em>).</p>
<p>The system restores access to this interface after the hostname update finishes.
For more information, read our
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/interface-lock-scripts/">Interface Lock Scripts</a>
documentation.</p>
<p><strong>Note:</strong></p>
<p>Whenever you change the server&#39;s hostname, you <strong>must</strong> use one of the following methods:</p>
<ul>
<li>Use WHM&#39;s
<a href="https://docs.cpanel.net/whm/networking-setup/change-hostname/"><em>Change Hostname</em></a>
interface (<em>WHM &gt;&gt; Home &gt;&gt; Networking Setup &gt;&gt; Change Hostname</em>).</li>
<li>Call WHM API 1&#39;s <code>sethostname</code> function.</li>
<li>Run the
<a href="https://docs.cpanel.net/whm/scripts/the-set_hostname-utility/"><code>/usr/local/cpanel/bin/set_hostname</code> utility</a>
as the <code>root</code> user.
These methods ensure that all of the necessary system and service changes occur.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes the server's hostname.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>Do <strong>not</strong> select a hostname that begins with <code>www</code> or a number, or a
hostname that ends with a hyphen (<code>-</code>) character.</li>
<li>You <strong>must</strong> use a fully-qualified domain name (FQDN) that contains two periods
(for example, <code>hostname.example.com</code>).</li>
<li>Do <strong>not</strong> choose a hostname that a cPanel account on your server will use.</li>
<li>Do <strong>not</strong> choose a potential service subdomain (proxy subdomain) as a hostname
(for example, <code>cpanel.example.com</code> or <code>whm.example.com</code>).</li>
</ul>
<p><strong>Important:</strong></p>
<p>If you update your hostname, the system blocks user access to cPanel's <a href="https://go.cpanel.net/calendars"><em>Calendars and Contacts</em></a> interface (<em>cPanel >> Home >> Email >> Calendars and Contacts</em>).</p>
<p>The system restores access to this interface after the hostname update finishes.
For more information, read our
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/interface-lock-scripts/">Interface Lock Scripts</a>
documentation.</p>
<p><strong>Note:</strong></p>
<p>Whenever you change the server's hostname, you <strong>must</strong> use one of the following methods:</p>
<ul>
<li>Use WHM's
<a href="https://docs.cpanel.net/whm/networking-setup/change-hostname/"><em>Change Hostname</em></a>
interface (<em>WHM >> Home >> Networking Setup >> Change Hostname</em>).</li>
<li>Call WHM API 1's <code>sethostname</code> function.</li>
<li>Run the
<a href="https://docs.cpanel.net/whm/scripts/the-set_hostname-utility/"><code>/usr/local/cpanel/bin/set_hostname</code> utility</a>
as the <code>root</code> user.
These methods ensure that all of the necessary system and service changes 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="last "><td kind="field" title="hostname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">hostname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->hostname<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">hostname=hostname.example.com</span></div><div><div html="<p>The server&#39;s new hostname.</p>
<p><strong>Important:</strong></p>
<p>The server&#39;s hostname should <strong>never</strong> be identical to the domain name. For example,
if the domain is <code>example.com</code>, you could use a hostname such as <code>server1.example.com</code>,
but <strong>not</strong> <code>example.com</code>. </p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server's new hostname.</p>
<p><strong>Important:</strong></p>
<p>The server's hostname should <strong>never</strong> be identical to the domain name. For example,
if the domain is <code>example.com</code>, you could use a hostname such as <code>server1.example.com</code>,
but <strong>not</strong> <code>example.com</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="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">/sethostname</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/sethostname</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99epca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99epca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99epca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99epca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99epca:0" aria-labelledby="tab:R99epca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
sethostname <span class="token punctuation">\</span>
<span class="token assign-left variable">hostname</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:R99epca:1" aria-labelledby="tab:R99epca: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:R9pepca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pepca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pepca:0" aria-labelledby="tab:R9pepca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"sethostname"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token string">"Updating cPanel license...Done. Update succeeded."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token string">"The hostname was already set to hostname.example.com, syncing configuration only."</span></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">"Stopping cPHulkd during hostname change\nService “cphulkd” is already stopped.<br />\n<br />\n<span class='cpanel_output_color_bold'>Startup Log</span><br />\n <span class='cpanel_output_indent'></span><span class='cpanel_output_color_bold cpanel_output_ color_bright_yellow cpanel_output_color_on_grey6'>Warning: Journal has been rotated since unit was started. Log output is incomplete or unavailable.</span><br />\n<br />\n<span class= 'cpanel_output_color_bold okmsg'>cphulkd stopped successfully.</span><br />\nStopping MySQL during hostname change\nChanging hostname in kernel to hostname.example.com\nAltered hostname in /etc/sysconfig/network\nUpdating cPHulkd\nStarting cPHulkd\n(XID qju5cf) The “cphulkd” service is not configured.\nRestarting Exim\nWaiting for “exim” to restart ………waiting for “exim” to initialize ………finished.<br />\n<br />\n<span class='cpanel_output_color_bold'>Service Status</span><br />\n<span class='cpanel_output_indent'></span>exim (/usr/sbin/exim -ps -bd -q1h -oP /var/spool/exim/exim-daemon.pid) is running as mailnull with PID 16943 (systemd+/proc check method).<br />\n<br />\n<span class='cpanel_output_color_bold'>Startup Log</span><br />\n <span class='cpanel_output_indent'></span>Jul 29 15:03:14 hostname.example.com systemd[1]: Starting Exim is a Mail Transport Agent, which is the program that moves mail from one machine to another....<br />\n<span class='cpanel_output_indent'></span>Jul 29 15:03:14 hostname. example.com systemd[1]: Can&#39;t open PID file /var/spool/exim/exim-daemon.pid (yet?) after start: No such file or directory<br />\n<span class='cpanel_output_indent'></span>Jul 29 15:03:14 hostname.example.com systemd[1]: Started Exim is a Mail Transport Agent, which is the program that moves mail from one machine to another..<br />\n<br />\n<span class='cpanel_output_ color_bold'>Log Messages</span><br />\n<span class='cpanel_output_indent'></span>2020-07-29 15:03:14 exim 4.93 daemon started: pid=16943, -q1h, listening for SMTP on port 25 (IPv6 and IPv4) port 587 (IPv6 and IPv4) and for SMTPS on port 465 (IPv6 and IPv4)<br />\n<span class='cpanel_ output_indent'></span>2020-07-29 14:57:20 exim 4.93 daemon started: pid=16089, -q1h, listening for SMTP on port 25 (IPv6 and IPv4) port 587 (IPv6 and IPv4) and for SMTPS on port 465 (IPv6 and IPv4)<br />\n<br />\n<span class='cpanel_output_color_bold okmsg'>exim restarted successfully.</span><br />\nUpdating Apache configuration\nUpdating cPanel license...Done. Update succeeded.\nA DNS record already exists for “hostname.example.com”.\nThe system has queued the hostname changes for the DAV services.\nUsers cannot access the DAV features that use these services until\nthe system has finished updates to the hostname. After the system adjusts a\nspecific user’s database, it restores their access to the DAV services.\n\nYou will receive a notification when the system completes the update for all users.\nWaiting for “mysql” to start ……waiting for “mysql” to initialize ………finished.<br />\n<br />\n<span class='cpanel_output_color_bold'>Service Status</span><br />\n<span class='cpanel_output_indent'></span>mysqld (/usr/sbin/mysqld --daemonize --pid-file= /var/run/mysqld/mysqld.pid) is running as mysql with PID 16886 (systemd+/proc check method). <br />\n<br />\n<span class='cpanel_output_color_bold'>Startup Log</span><br />\n<span class= 'cpanel_output_indent'></span>Jul 29 15:03:10 hostname.example.com systemd[1]: Starting MySQL Server...<br />\n<span class='cpanel_output_indent'></span>Jul 29 15:03:11 hostname.example.com systemd[1]: Started MySQL Server.<br />\n<br />\n<span class='cpanel_output_color_bold'>Log Messages</span><br />\n<span class='cpanel_output_indent'></span>2020-07-29T20:03:11.894935Z 0 [Note] /usr/sbin/mysqld: ready for connections.<br />\n<span class='cpanel_output_indent'> </span>2020-07-29T20:03:09.442015Z 0 [Note] /usr/sbin/mysqld: Shutdown complete<br />\n<span class='cpanel_output_indent'></span>2020-07-29T19:57:17.010586Z 0 [Note] /usr/sbin/mysqld: ready for connections.<br />\n<br />\n<span class='cpanel_output_color_bold okmsg'>mysql started successfully.</span><br />"</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/System-Information/operation/set_primary_servername" data-section-id="tag/System-Information/operation/set_primary_servername" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_primary_servername" id="operation/set_primary_servername" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/System-Information/operation/set_primary_servername" aria-label="tag/System-Information/operation/set_primary_servername"></a>Update server's primary virtual host<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the primary domain hosted on an IP address and web server port. The primary domain refers to the virtual host that the server returns when a visitor directly accesses the IP address.</p>
<p>For example, if both <code>example1.com</code> and <code>example2.com</code> are name-based virtual hosts on IP address <code>192.168.0.1</code>, the primary virtual host appears when the visitor accesses the <code>http://192.168.0.1/</code> location.</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 sets the primary domain hosted on an IP address and web server port. The primary domain refers to the virtual host that the server returns when a visitor directly accesses the IP address.</p>
<p>For example, if both <code>example1.com</code> and <code>example2.com</code> are name-based virtual hosts on IP address <code>192.168.0.1</code>, the primary virtual host appears when the visitor accesses the <code>http://192.168.0.1/</code> location.</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="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 <code>ServerName</code> value in Apache&#39;s <code>VirtualHost</code> section to set as primary for the IP address and port type.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <code>ServerName</code> value in Apache's <code>VirtualHost</code> section to set as primary for the IP address and port type.</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">"std"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"std"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ssl"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=std</span></div><div><div html="<p>The type of virtual host to set as primary.</p>
<ul>
<li><code>std</code> — Set the primary domain for the HTTP port. Typically, port <code>80</code>.</li>
<li><code>ssl</code> — Set the primary domain for the HTTPS port. Typically, port <code>443</code>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of virtual host to set as primary.</p>
<ul>
<li><code>std</code> — Set the primary domain for the HTTP port. Typically, port <code>80</code>.</li>
<li><code>ssl</code> — Set the primary domain for the HTTPS port. Typically, port <code>443</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="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">/set_primary_servername</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_primary_servername</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99ipca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ipca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ipca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ipca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ipca:0" aria-labelledby="tab:R99ipca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_primary_servername <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:R99ipca:1" aria-labelledby="tab:R99ipca: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:R9pipca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pipca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pipca:0" aria-labelledby="tab:R9pipca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_primary_servername"</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/System-Information/operation/getdiskusage" data-section-id="tag/System-Information/operation/getdiskusage" class="sc-dntaoT ceciOs"><div data-section-id="operation/getdiskusage" id="operation/getdiskusage" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/System-Information/operation/getdiskusage" aria-label="tag/System-Information/operation/getdiskusage"></a>Return server's drive partition information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the server&#39;s drive partition information.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the server's drive partition 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/getdiskusage</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/getdiskusage</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99mpca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99mpca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99mpca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99mpca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99mpca:0" aria-labelledby="tab:R99mpca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
getdiskusage
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99mpca:1" aria-labelledby="tab:R99mpca: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:R9pmpca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pmpca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pmpca:0" aria-labelledby="tab:R9pmpca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"partition"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">377856</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"device"</span>: <span class="token string">"/dev/vda1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disk"</span>: <span class="token string">"vda1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filesystem"</span>: <span class="token string">"/"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inodes_available"</span>: <span class="token number">20575847</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inodes_ipercentage"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inodes_total"</span>: <span class="token number">20970944</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inodes_used"</span>: <span class="token number">395097</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mount"</span>: <span class="token string">"/boot"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"percentage"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total"</span>: <span class="token number">495844</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">92388</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">"metadata"</span>: <button class="collapser" aria-label="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">"getdiskusage"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Successfully retrieved disk usage"</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/System-Information/operation/gethostname" data-section-id="tag/System-Information/operation/gethostname" class="sc-dntaoT ceciOs"><div data-section-id="operation/gethostname" id="operation/gethostname" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/System-Information/operation/gethostname" aria-label="tag/System-Information/operation/gethostname"></a>Return server's hostname<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the server&#39;s hostname.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the 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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/gethostname</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/gethostname</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99qpca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99qpca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99qpca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99qpca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99qpca:0" aria-labelledby="tab:R99qpca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
gethostname
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99qpca:1" aria-labelledby="tab:R99qpca: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:R9pqpca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pqpca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pqpca:0" aria-labelledby="tab:R9pqpca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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></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">"command"</span>: <span class="token string">"gethostname"</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/System-Information/operation/reboot" data-section-id="tag/System-Information/operation/reboot" class="sc-dntaoT ceciOs"><div data-section-id="operation/reboot" id="operation/reboot" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/System-Information/operation/reboot" aria-label="tag/System-Information/operation/reboot"></a>Restart server<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function reboots the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function reboots the 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="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 use a forceful reboot.</p>
<ul>
<li><code>1</code> - Use a forceful reboot.</li>
<li><code>0</code> - Do <strong>not</strong> use a forceful reboot.</li>
</ul>
<p><strong>Warning:</strong></p>
<p> A forceful reboot may result in data loss if active processes exist on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use a forceful reboot.</p>
<ul>
<li><code>1</code> - Use a forceful reboot.</li>
<li><code>0</code> - Do <strong>not</strong> use a forceful reboot.</li>
</ul>
<p><strong>Warning:</strong></p>
<p> A forceful reboot may result in data loss if active processes exist on the 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="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">/reboot</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/reboot</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99upca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99upca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99upca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99upca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99upca:0" aria-labelledby="tab:R99upca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
<span class="token function">reboot</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99upca:1" aria-labelledby="tab:R99upca: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:R9pupca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pupca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pupca:0" aria-labelledby="tab:R9pupca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"reboot"</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/Updates" data-section-id="tag/Updates" 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/Updates" aria-label="tag/Updates"></a>Updates</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Server Administration / Updates</p>
"><p>Server Administration / Updates</p>
</div></div></div><div id="tag/Updates/operation/installed_versions" data-section-id="tag/Updates/operation/installed_versions" class="sc-dntaoT ceciOs"><div data-section-id="operation/installed_versions" id="operation/installed_versions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Updates/operation/installed_versions" aria-label="tag/Updates/operation/installed_versions"></a>Return third-party software versions<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the versions of third-party software that ship with cPanel &amp; WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the versions of third-party software that ship with cPanel & WHM.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="packages" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">packages</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">packages=1</span></div><div><div html="<p>Whether to list the server&#39;s installed RPMs in the function&#39;s
<code>cpanel_packages</code>, <code>ea_4_packages</code>, and <code>os_packages</code> arrays.</p>
<ul>
<li><code>1</code> - List.</li>
<li><code>0</code> - Do <strong>not</strong> list.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to list the server's installed RPMs in the function's
<code>cpanel_packages</code>, <code>ea_4_packages</code>, and <code>os_packages</code> arrays.</p>
<ul>
<li><code>1</code> - List.</li>
<li><code>0</code> - Do <strong>not</strong> 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:Rii6rca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii6rca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii6rca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii6rca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii6rca:0" aria-labelledby="tab:Rii6rca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
installed_versions
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii6rca:1" aria-labelledby="tab:Rii6rca: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:Rji6rca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji6rca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji6rca:0" aria-labelledby="tab:Rji6rca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apache"</span>: <span class="token string">"2.4.12"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"apache_php_default_version"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"apache_php_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 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">"bind"</span>: <span class="token string">"9.9.4-29"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"clamav"</span>: <span class="token string">"0.99.2-1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpanel_and_whm"</span>: <span class="token string">"11.64.0.9999"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpanel_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 string">"cpanel-ace-editor-1.2.6-1.cp1166.noarch"</span>,</div></li><li><div class="hoverable "><span class="token string">"cpanel-yui-2.9.0-5.cp1136.noarch"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpanel_php"</span>: <span class="token string">"7.2.7-4"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cron"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cronie"</span>: <span class="token string">"1.4.11-23"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dovecot"</span>: <span class="token string">"2.2.31 (65cde28)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ea_4_packages"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"easyapache"</span>: <span class="token string">"4"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exim"</span>: <span class="token string">"4.89-2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"linux_kernel"</span>: <span class="token string">"3.10.0-327.18.2.el7.x86_64"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailman"</span>: <span class="token string">"2.1.23-9"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mariadb"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mariadb_build"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"munin"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql"</span>: <span class="token string">"5.7.61"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_build"</span>: <span class="token string">"5.7.61-1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nscd"</span>: <span class="token string">"2.17-222"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"openssh-server"</span>: <span class="token string">"7.4p1-21"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"operating_system_name"</span>: <span class="token string">"centos"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"operating_system_version"</span>: <span class="token string">"7.2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"os_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 string">"ImageMagick-6.7.8.9-15.el7_2.x86_64"</span>,</div></li><li><div class="hoverable "><span class="token string">"zsh-5.0.2-14.el7.x86_64"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"p0f"</span>: <span class="token string">"3.09b-1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"postgresql"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"postgresql_build"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"powerdns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proftpd"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pureftpd"</span>: <span class="token string">"1.0.45"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"roundcube"</span>: <span class="token string">"1.2.4-1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rsyslog"</span>: <span class="token string">"8.24.0-16"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spamd"</span>: <span class="token string">"3.4.2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"squirrelmail"</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">"metadata"</span>: <button class="collapser" aria-label="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">"installed_versions"</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/Updates/operation/update_updateconf" data-section-id="tag/Updates/operation/update_updateconf" class="sc-dntaoT ceciOs"><div data-section-id="operation/update_updateconf" id="operation/update_updateconf" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Updates/operation/update_updateconf" aria-label="tag/Updates/operation/update_updateconf"></a>Update software update behavior<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function modifies a server&#39;s <code>/etc/cpupdate.conf</code> file. This file controls how the server handles software updates and upgrades.</p>
<p><strong>Important:</strong></p>
<p>You <strong>must</strong> have the <a href="https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges"><code>root</code> level Access Control List (ACL) privilege</a> to execute this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies a server's <code>/etc/cpupdate.conf</code> file. This file controls how the server handles software updates and upgrades.</p>
<p><strong>Important:</strong></p>
<p>You <strong>must</strong> have the <a href="https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges"><code>root</code> level Access Control List (ACL) privilege</a> to execute this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="CPANEL" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand CPANEL"><span class="property-name">CPANEL</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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">CPANEL=RELEASE</span></div><div><div html="<p>The cPanel &amp; WHM installation&#39;s release tier, or a <a href="https://go.cpanel.net/longtermsupport">valid version number</a>.</p>
<p>If you do not use this parameter, the system retains the current setting.</p>
<ul>
<li><p>A valid cPanel &amp; WHM version number.</p>
</li>
<li><p><code>STABLE</code> - This version has received considerable public exposure, testing, and verification.</p>
</li>
<li><p><code>RELEASE</code> - This version is feature-complete and well-tested. It contains all intended features and functionality.</p>
</li>
<li><p><code>CURRENT</code> - This version is tested and verified, but it may not contain all of the proposed functionality of a release. This tier is similar to the &quot;release candidate&quot; tier that other publication schemes use.</p>
</li>
<li><p><code>EDGE</code> - This version only has rudimentary testing. The features are subject to further modification. This version usually lacks official public documentation.</p>
</li>
<li><p><code>LTS</code> - Some hosting providers do not wish to upgrade cPanel &amp; WHM to newer major versions. This is a single cPanel &amp; WHM version for the year-long period in which WebPros International, LLC supports it.</p>
<p>If you do not set this parameter, the system retains the current setting.</p>
</li>
</ul>
<p> New installations default to RELEASE.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel & WHM installation's release tier, or a <a href="https://go.cpanel.net/longtermsupport">valid version number</a>.</p>
<p>If you do not use this parameter, the system retains the current setting.</p>
<ul>
<li><p>A valid cPanel & WHM version number.</p>
</li>
<li><p><code>STABLE</code> - This version has received considerable public exposure, testing, and verification.</p>
</li>
<li><p><code>RELEASE</code> - This version is feature-complete and well-tested. It contains all intended features and functionality.</p>
</li>
<li><p><code>CURRENT</code> - This version is tested and verified, but it may not contain all of the proposed functionality of a release. This tier is similar to the "release candidate" tier that other publication schemes use.</p>
</li>
<li><p><code>EDGE</code> - This version only has rudimentary testing. The features are subject to further modification. This version usually lacks official public documentation.</p>
</li>
<li><p><code>LTS</code> - Some hosting providers do not wish to upgrade cPanel & WHM to newer major versions. This is a single cPanel & WHM version for the year-long period in which WebPros International, LLC supports it.</p>
<p>If you do not set this parameter, the system retains the current setting.</p>
</li>
</ul>
<p> New installations default to RELEASE.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="RPMUP" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand RPMUP"><span class="property-name">RPMUP</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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">RPMUP=daily</span></div><div><div html="<p>The frequency with which the server updates the operating system distribution&#39;s packages each time that the <code>/usr/local/cpanel/scripts/upcp</code> script runs.</p>
<p>If you do not set this parameter, the system retains the current setting.</p>
<ul>
<li><code>daily</code> - Update the system packages daily.</li>
<li><code>manual</code> - Update the system packages manually.</li>
<li><code>never</code> - If you specify <code>never</code>, the server administrator <strong>must</strong> run the <code>/usr/local/cpanel/scripts/update-packages</code> script when they update the server&#39;s packages.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The frequency with which the server updates the operating system distribution's packages each time that the <code>/usr/local/cpanel/scripts/upcp</code> script runs.</p>
<p>If you do not set this parameter, the system retains the current setting.</p>
<ul>
<li><code>daily</code> - Update the system packages daily.</li>
<li><code>manual</code> - Update the system packages manually.</li>
<li><code>never</code> - If you specify <code>never</code>, the server administrator <strong>must</strong> run the <code>/usr/local/cpanel/scripts/update-packages</code> script when they update the server's packages.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="SARULESUP" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand SARULESUP"><span class="property-name">SARULESUP</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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">SARULESUP=daily</span></div><div><div html="<p>The frequency with which the server updates Apache SpamAssassin&#39;s™ rules when the <code>/usr/local/cpanel/scripts/upcp</code> script runs.</p>
<p>If you do not set this parameter, the system retains the current setting.</p>
<ul>
<li><code>daily</code> - Update Apache SpamAssassin rules daily.</li>
<li><code>manual</code> - Update Apache SpamAssassin rules manually.</li>
<li><code>never</code> - If you specify <code>never</code>, the server administrator <strong>must</strong> run the <code>/usr/local/cpanel/scripts/update-packages</code> script when they update Apache SpamAssassin&#39;s rules.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The frequency with which the server updates Apache SpamAssassin's™ rules when the <code>/usr/local/cpanel/scripts/upcp</code> script runs.</p>
<p>If you do not set this parameter, the system retains the current setting.</p>
<ul>
<li><code>daily</code> - Update Apache SpamAssassin rules daily.</li>
<li><code>manual</code> - Update Apache SpamAssassin rules manually.</li>
<li><code>never</code> - If you specify <code>never</code>, the server administrator <strong>must</strong> run the <code>/usr/local/cpanel/scripts/update-packages</code> script when they update Apache SpamAssassin's rules.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="STAGING_DIR" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">STAGING_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">STAGING_DIR=/usr/local/cpanel</span></div><div><div html="<p>The absolute directory path to the staging directory for updates.</p>
<p>If you do not set this parameter, the system retains the current setting.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute directory path to the staging directory for updates.</p>
<p>If you do not set this parameter, the system retains the current setting.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="UPDATES" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand UPDATES"><span class="property-name">UPDATES</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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">UPDATES=daily</span></div><div><div html="<p>When the system will check for updates.</p>
<p>If you do not set this parameter, the system retains the current setting.</p>
<ul>
<li><code>daily</code> - Update cPanel &amp; WHM automatically through a cron job once every 24 hours.</li>
<li><code>manual</code> - Update cPanel &amp; WHM manually.</li>
<li><code>never</code> - Do <strong>not</strong> update cPanel &amp; WHM.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>When the system will check for updates.</p>
<p>If you do not set this parameter, the system retains the current setting.</p>
<ul>
<li><code>daily</code> - Update cPanel & WHM automatically through a cron job once every 24 hours.</li>
<li><code>manual</code> - Update cPanel & WHM manually.</li>
<li><code>never</code> - Do <strong>not</strong> update cPanel & WHM.</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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/update_updateconf</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/update_updateconf</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiarca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiarca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiarca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiarca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiarca:0" aria-labelledby="tab:Riiarca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
update_updateconf
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiarca:1" aria-labelledby="tab:Riiarca: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:Rjiarca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiarca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiarca:0" aria-labelledby="tab:Rjiarca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"update_updateconf"</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/Updates/operation/accept_eula" data-section-id="tag/Updates/operation/accept_eula" class="sc-dntaoT ceciOs"><div data-section-id="operation/accept_eula" id="operation/accept_eula" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Updates/operation/accept_eula" aria-label="tag/Updates/operation/accept_eula"></a>Save EULA acceptance<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function records acceptance of cPanel &amp; WHM&#39;s legal terms. To do this, the function creates a touchfile in the <code>/var/cpanel/activate/</code> directory.</p>
<p><strong>Important:</strong></p>
<p> Server owners <em>must</em> accept these agreements before they use cPanel &amp; WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function records acceptance of cPanel & WHM's legal terms. To do this, the function creates a touchfile in the <code>/var/cpanel/activate/</code> directory.</p>
<p><strong>Important:</strong></p>
<p> Server owners <em>must</em> accept these agreements before they use cPanel & WHM.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/accept_eula</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/accept_eula</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riierca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riierca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riierca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riierca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riierca:0" aria-labelledby="tab:Riierca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
accept_eula
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riierca:1" aria-labelledby="tab:Riierca: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:Rjierca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjierca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjierca:0" aria-labelledby="tab:Rjierca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"accept_eula"</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/Updates/operation/set_tier" data-section-id="tag/Updates/operation/set_tier" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_tier" id="operation/set_tier" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Updates/operation/set_tier" aria-label="tag/Updates/operation/set_tier"></a>Update cPanel & WHM release tier<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets a cPanel &amp; WHM server to a specified <a href="https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/">support tier</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets a cPanel & WHM server to a specified <a href="https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/">support tier</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="tier" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">tier</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"edge"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"current"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"release"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"stable"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"lts"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">tier=current</span></div><div><div html="<p>The support tier to use.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The support tier 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/set_tier</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_tier</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiirca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiirca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiirca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiirca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiirca:0" aria-labelledby="tab:Riiirca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_tier <span class="token punctuation">\</span>
<span class="token assign-left variable">tier</span><span class="token operator">=</span><span class="token string">'current'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiirca:1" aria-labelledby="tab:Riiirca: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:Rjiirca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiirca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiirca:0" aria-labelledby="tab:Rjiirca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"tier"</span>: <span class="token string">"current"</span></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">"command"</span>: <span class="token string">"set_tier"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Update tier successfully changed to current"</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/Updates/operation/get_available_tiers" data-section-id="tag/Updates/operation/get_available_tiers" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_available_tiers" id="operation/get_available_tiers" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Updates/operation/get_available_tiers" aria-label="tag/Updates/operation/get_available_tiers"></a>Return cPanel & WHM available versions<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists of each available version of cPanel &amp; WHM, and each
version&#39;s latest maintenance release. This function also lists the cPanel &amp; WHM
version for each
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/">release tier</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists of each available version of cPanel & WHM, and each
version's latest maintenance release. This function also lists the cPanel & WHM
version for each
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/">release tier</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><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>A list of the latest available version of cPanel &amp; WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of the latest available version of cPanel & WHM.</p>
</div></div></div></td></tr><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">/get_available_tiers</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_available_tiers</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riimrca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riimrca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riimrca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riimrca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riimrca:0" aria-labelledby="tab:Riimrca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_available_tiers
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riimrca:1" aria-labelledby="tab:Riimrca: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:Rjimrca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjimrca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjimrca:0" aria-labelledby="tab:Rjimrca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"11.30"</span>: <span class="token string">"11.30.8.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.32"</span>: <span class="token string">"11.32.7.3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.34"</span>: <span class="token string">"11.34.2.8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.36"</span>: <span class="token string">"11.36.2.12"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.38"</span>: <span class="token string">"11.38.2.23"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.40"</span>: <span class="token string">"11.40.1.22"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.42"</span>: <span class="token string">"11.42.1.31"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.44"</span>: <span class="token string">"11.44.3.5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.46"</span>: <span class="token string">"11.46.4.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.48"</span>: <span class="token string">"11.48.5.3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.50"</span>: <span class="token string">"11.50.6.2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.52"</span>: <span class="token string">"11.52.6.6"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.54"</span>: <span class="token string">"11.54.0.36"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.56"</span>: <span class="token string">"11.56.0.52"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.58"</span>: <span class="token string">"11.58.0.52"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.60"</span>: <span class="token string">"11.60.0.48"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.62"</span>: <span class="token string">"11.62.0.48"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.64"</span>: <span class="token string">"11.64.0.42"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.66"</span>: <span class="token string">"11.66.0.35"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.68"</span>: <span class="token string">"11.68.0.39"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.70"</span>: <span class="token string">"11.70.0.69"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.72"</span>: <span class="token string">"11.72.0.12"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.74"</span>: <span class="token string">"11.74.0.12"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.76"</span>: <span class="token string">"11.76.0.22"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.78"</span>: <span class="token string">"11.78.0.49"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.80"</span>: <span class="token string">"11.80.0.24"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.82"</span>: <span class="token string">"11.82.0.19"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.84"</span>: <span class="token string">"11.84.0.22"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.86"</span>: <span class="token string">"11.86.0.24"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.88"</span>: <span class="token string">"11.88.0.13"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"11.90"</span>: <span class="token string">"11.90.0.3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"current"</span>: <span class="token string">"11.90.0.3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edge"</span>: <span class="token string">"11.90.0.3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lts"</span>: <span class="token string">"11.86.0.24"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"release"</span>: <span class="token string">"11.88.0.13"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stable"</span>: <span class="token string">"11.88.0.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">"metadata"</span>: <button class="collapser" aria-label="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">"get_available_tiers"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Got tiers list"</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/Updates/operation/set_cpanel_updates" data-section-id="tag/Updates/operation/set_cpanel_updates" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_cpanel_updates" id="operation/set_cpanel_updates" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Updates/operation/set_cpanel_updates" aria-label="tag/Updates/operation/set_cpanel_updates"></a>Update cPanel & WHM update frequency<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the frequency of cPanel &amp; WHM updates.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the frequency of cPanel & WHM updates.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="updates" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">updates</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"daily"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"manual"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"never"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">updates=daily</span></div><div><div html="<p>The frequency with which to run cPanel &amp; WHM updates on a server.</p>
<ul>
<li><code>daily</code> — Run updates daily.</li>
<li><code>manual</code> — Run updates manually.</li>
<li><code>never</code> — Never run updates.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The frequency with which to run cPanel & WHM updates on a server.</p>
<ul>
<li><code>daily</code> — Run updates daily.</li>
<li><code>manual</code> — Run updates manually.</li>
<li><code>never</code> — Never run updates.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/set_cpanel_updates</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_cpanel_updates</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiqrca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiqrca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiqrca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiqrca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiqrca:0" aria-labelledby="tab:Riiqrca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_cpanel_updates <span class="token punctuation">\</span>
<span class="token assign-left variable">updates</span><span class="token operator">=</span><span class="token string">'daily'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiqrca:1" aria-labelledby="tab:Riiqrca: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:Rjiqrca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiqrca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiqrca:0" aria-labelledby="tab:Rjiqrca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"updates"</span>: <span class="token string">"daily"</span></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">"command"</span>: <span class="token string">"set_cpanel_updates"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Cpanel update frequency set to daily"</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/Updates/operation/get_current_lts_expiration_status" data-section-id="tag/Updates/operation/get_current_lts_expiration_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_current_lts_expiration_status" id="operation/get_current_lts_expiration_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Updates/operation/get_current_lts_expiration_status" aria-label="tag/Updates/operation/get_current_lts_expiration_status"></a>Return Long Term Support expiration status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function determines whether a branch&#39;s Long-Term Support (LTS) version expires within three months. For more information about LTS, read our <a href="https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/#more-about-lts">cPanel Long-Term Support documentation</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function determines whether a branch's Long-Term Support (LTS) version expires within three months. For more information about LTS, read our <a href="https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/#more-about-lts">cPanel Long-Term Support 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_current_lts_expiration_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_current_lts_expiration_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:Riiurca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiurca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiurca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiurca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiurca:0" aria-labelledby="tab:Riiurca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_current_lts_expiration_status
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiurca:1" aria-labelledby="tab:Riiurca: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:Rjiurca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiurca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiurca:0" aria-labelledby="tab:Rjiurca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"expiration"</span>: <span class="token number">1585612801</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_in_next_three_months"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_version"</span>: <span class="token string">"11.88.1.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">"metadata"</span>: <button class="collapser" aria-label="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">"get_current_lts_expiration_status"</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/Updates/operation/get_lts_wexpire" data-section-id="tag/Updates/operation/get_lts_wexpire" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_lts_wexpire" id="operation/get_lts_wexpire" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Updates/operation/get_lts_wexpire" aria-label="tag/Updates/operation/get_lts_wexpire"></a>Return Long Term Support status for all versions<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function parses the <code>/etc/cpanel/TIERS.json</code> file and returns whether a branch qualifies for Long-Term Support (LTS). For more information about LTS, read our <a href="https://go.cpanel.net/cpanel-lts">cPanel Long-Term Support</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function parses the <code>/etc/cpanel/TIERS.json</code> file and returns whether a branch qualifies for Long-Term Support (LTS). For more information about LTS, read our <a href="https://go.cpanel.net/cpanel-lts">cPanel Long-Term Support</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_lts_wexpire</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_lts_wexpire</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij2rca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij2rca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij2rca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij2rca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij2rca:0" aria-labelledby="tab:Rij2rca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_lts_wexpire
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij2rca:1" aria-labelledby="tab:Rij2rca: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:Rjj2rca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj2rca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj2rca:0" aria-labelledby="tab:Rjj2rca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"branch"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"11.78.0"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token string">"11.78.0.49"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</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">"11.80.0"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token string">"11.80.0.24"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</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">"11.82.0"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token string">"11.82.0.19"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</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">"11.84.0"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token string">"11.84.0.22"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</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">"11.86.0"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token string">"11.86.0.25"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</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">"11.88.0"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token string">"11.88.0.14"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</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">"11.90.0"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token string">"11.90.0.5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</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">"flags"</span>: <button class="collapser" aria-label="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_main"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tiers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"11.78"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token string">"11.78.0.49"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires"</span>: <span class="token string">"1588636799"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_lts"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</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">"11.80"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token string">"11.80.0.24"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</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">"11.82"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token string">"11.82.0.19"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</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">"11.84"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token string">"11.84.0.22"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</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">"11.86"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token string">"11.86.0.25"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires"</span>: <span class="token string">"1617148801"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_lts"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"named"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"lts"</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">"11.88"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token string">"11.88.0.13"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"named"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"stable"</span></div></li></ul><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">"build"</span>: <span class="token string">"11.88.0.14"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</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">"11.90"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token string">"11.90.0.5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_main"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"named"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"current"</span>,</div></li><li><div class="hoverable "><span class="token string">"edge"</span>,</div></li><li><div class="hoverable "><span class="token string">"release"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_lts_wexpire"</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/Updates/operation/get_update_availability" data-section-id="tag/Updates/operation/get_update_availability" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_update_availability" id="operation/get_update_availability" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Updates/operation/get_update_availability" aria-label="tag/Updates/operation/get_update_availability"></a>Return if server uses the default update version<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks whether your server uses the
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/">latest version of cPanel &amp; WHM for your release tier</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether your server uses the
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/">latest version of cPanel & WHM for your release tier</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_update_availability</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_update_availability</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij6rca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij6rca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij6rca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij6rca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij6rca:0" aria-labelledby="tab:Rij6rca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_update_availability
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij6rca:1" aria-labelledby="tab:Rij6rca: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:Rjj6rca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj6rca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj6rca:0" aria-labelledby="tab:Rjj6rca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_version"</span>: <span class="token string">"88.0.12"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"newest_version"</span>: <span class="token string">"88.0.12"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tier"</span>: <span class="token string">"current"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_available"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_update_availability"</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/Updates/operation/start_cpanel_update" data-section-id="tag/Updates/operation/start_cpanel_update" class="sc-dntaoT ceciOs"><div data-section-id="operation/start_cpanel_update" id="operation/start_cpanel_update" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Updates/operation/start_cpanel_update" aria-label="tag/Updates/operation/start_cpanel_update"></a>Start cPanel & WHM update<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function starts an update of cPanel &amp; WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function starts an update of cPanel & WHM.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="mode" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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 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">"force"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"sync"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mode=force</span></div><div><div html="<p>The cPanel &amp; WHM update’s mode of operation.</p>
<ul>
<li>null — Only reinstall cPanel &amp; WHM if a newer version is available.</li>
<li><code>force</code> — Force a reinstall of cPanel &amp; WHM, even if the system is up to date.</li>
<li><code>sync</code> — Update the currently-installed version of cPanel &amp; WHM instead of downloading
a newer version. This ensures the current version installed has the correct files.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel & WHM update’s mode of operation.</p>
<ul>
<li>null — Only reinstall cPanel & WHM if a newer version is available.</li>
<li><code>force</code> — Force a reinstall of cPanel & WHM, even if the system is up to date.</li>
<li><code>sync</code> — Update the currently-installed version of cPanel & WHM instead of downloading
a newer version. This ensures the current version installed has the correct 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/start_cpanel_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/start_cpanel_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:Rijarca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijarca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijarca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijarca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijarca:0" aria-labelledby="tab:Rijarca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 start_cpanel_update</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijarca:1" aria-labelledby="tab:Rijarca: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:Rjjarca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjarca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjarca:0" aria-labelledby="tab:Rjjarca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_new"</span>: <span class="token number">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">"/var/cpanel/updatelogs/update.1604521159.log"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pid"</span>: <span class="token number">23456</span></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">"command"</span>: <span class="token string">"start_cpanel_update"</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/Updates/operation/manage_features" data-section-id="tag/Updates/operation/manage_features" class="sc-dntaoT ceciOs"><div data-section-id="operation/manage_features" id="operation/manage_features" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Updates/operation/manage_features" aria-label="tag/Updates/operation/manage_features"></a>Update Feature Showcase<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists and manages items in the
<a href="https://go.cpanel.net/GuidetotheFeatureShowcase">Feature Showcase</a>.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function&#39;s output changes, depending on which value you pass to the <code>action</code> parameter.</li>
<li>The example in this document displays the function&#39;s return when the <code>action</code>
parameter value is <code>info</code>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists and manages items in the
<a href="https://go.cpanel.net/GuidetotheFeatureShowcase">Feature Showcase</a>.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function's output changes, depending on which value you pass to the <code>action</code> parameter.</li>
<li>The example in this document displays the function's return when the <code>action</code>
parameter value is <code>info</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="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">"info"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"list"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"enable"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"disable"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">action=info</span></div><div><div html="<p>The function&#39;s action.</p>
<ul>
<li><code>info</code> — List full details for all available features.</li>
<li><code>list</code> — List the feature IDs for all available features.</li>
<li><code>enable</code> — Enable the feature or features called in the <code>features</code> parameter.</li>
<li><code>disable</code> — Disable the feature or features called in the <code>features</code> parameter.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The function's action.</p>
<ul>
<li><code>info</code> — List full details for all available features.</li>
<li><code>list</code> — List the feature IDs for all available features.</li>
<li><code>enable</code> — Enable the feature or features called in the <code>features</code> parameter.</li>
<li><code>disable</code> — Disable the feature or features called in the <code>features</code> parameter.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="features" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">features</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">features=features_example1</span></div><div><div html="<p>The feature&#39;s ID.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> use this parameter if you pass the <code>enable</code> or <code>disable</code> value for
the <code>action</code> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The feature's ID.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> use this parameter if you pass the <code>enable</code> or <code>disable</code> value for
the <code>action</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/manage_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/manage_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:Rijerca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijerca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijerca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijerca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijerca:0" aria-labelledby="tab:Rijerca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
manage_features <span class="token punctuation">\</span>
<span class="token assign-left variable">action</span><span class="token operator">=</span><span class="token string">'info'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijerca:1" aria-labelledby="tab:Rijerca: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:Rjjerca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjerca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjerca:0" aria-labelledby="tab:Rjjerca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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 feature does things."</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">"feature_key"</span>: <span class="token string">"featured_example1"</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://go.cpanel.net/featureshowcasefeatured_example1">https://go.cpanel.net/featureshowcasefeatured_example1</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Featured Example 1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recommended"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor"</span>: <span class="token string">"Third Party, Inc."</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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 feature also does things."</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">"feature_key"</span>: <span class="token string">"featured_example2"</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://go.cpanel.net/featureshowcasefeatured_example2">https://go.cpanel.net/featureshowcasefeatured_example2</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Featured Example 2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recommended"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor"</span>: <span class="token string">"WebPros International, LLC"</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">"metadata"</span>: <button class="collapser" aria-label="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">"manage_features"</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/Updates/operation/version" data-section-id="tag/Updates/operation/version" class="sc-dntaoT ceciOs"><div data-section-id="operation/version" id="operation/version" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Updates/operation/version" aria-label="tag/Updates/operation/version"></a>Return cPanel & WHM version<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns <a href="https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/">the cPanel &amp; WHM version</a> that a server runs.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns <a href="https://docs.cpanel.net/knowledge-base/cpanel-product/product-versions-and-the-release-process/">the cPanel & WHM version</a> that a server runs.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:Rijirca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijirca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijirca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijirca:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijirca:0" aria-labelledby="tab:Rijirca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
version
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijirca:1" aria-labelledby="tab:Rijirca: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:Rjjirca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjirca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjirca:0" aria-labelledby="tab:Rjjirca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"11.88.0.9999"</span></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">"command"</span>: <span class="token string">"version"</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/ServicesCluster" data-section-id="tag/ServicesCluster" 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/ServicesCluster" aria-label="tag/ServicesCluster"></a>ServicesCluster</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>ServicesCluster</p>
"><p>ServicesCluster</p>
</div></div></div><div id="tag/Auto-Generated-Certificates" data-section-id="tag/Auto-Generated-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-Certificates" aria-label="tag/Auto-Generated-Certificates"></a>Auto-Generated 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 Certificates</p>
"><p>SSL Certificates / Auto-Generated Certificates</p>
</div></div></div><div id="tag/Auto-Generated-Certificates/operation/add_autossl_user_excluded_domains" data-section-id="tag/Auto-Generated-Certificates/operation/add_autossl_user_excluded_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_autossl_user_excluded_domains" id="operation/add_autossl_user_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-Certificates/operation/add_autossl_user_excluded_domains" aria-label="tag/Auto-Generated-Certificates/operation/add_autossl_user_excluded_domains"></a>Disable AutoSSL for domain<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function disables AutoSSL for an account&#39;s specified domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables AutoSSL for an account's specified 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=""><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">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->domain<!-- -->><!-- --> </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <<!-- -->domain<!-- --> ></span> ]</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=example1.com&domain=example2.com</span> -<!-- --> <!-- -->Disable AutoSSL for multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> -<!-- --> <!-- -->Disable AutoSSL for a single domain.</li></ul><div><div html="<p>Disable AutoSSL for this domain.</p>
<p><strong>Note:</strong></p>
<p>To disable AutoSSL for multiple domains, increment the parameter name. For example, <code>domain=example.com</code>, <code>domain-1=example1.com</code>, and <code>domain-2=example.com</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Disable AutoSSL for this domain.</p>
<p><strong>Note:</strong></p>
<p>To disable AutoSSL for multiple domains, increment the parameter name. For example, <code>domain=example.com</code>, <code>domain-1=example1.com</code>, and <code>domain-2=example.com</code>.</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 cPanel user&#39;s account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel user's 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="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">/add_autossl_user_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/add_autossl_user_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:R991jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R991jda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R991jda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R991jda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R991jda:0" aria-labelledby="tab:R991jda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
add_autossl_user_excluded_domains <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:R991jda:1" aria-labelledby="tab:R991jda: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:R9p1jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p1jda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p1jda:0" aria-labelledby="tab:R9p1jda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"add_autossl_user_excluded_domains"</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/Auto-Generated-Certificates/operation/disable_autossl" data-section-id="tag/Auto-Generated-Certificates/operation/disable_autossl" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_autossl" id="operation/disable_autossl" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-Generated-Certificates/operation/disable_autossl" aria-label="tag/Auto-Generated-Certificates/operation/disable_autossl"></a>Disable AutoSSL<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function disables the AutoSSL feature.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables the AutoSSL feature.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/disable_autossl</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/disable_autossl</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R992jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R992jda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R992jda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R992jda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R992jda:0" aria-labelledby="tab:R992jda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
disable_autossl
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R992jda:1" aria-labelledby="tab:R992jda: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:R9p2jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p2jda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p2jda:0" aria-labelledby="tab:R9p2jda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"disable_autossl"</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/Auto-Generated-Certificates/operation/get_autossl_check_schedule" data-section-id="tag/Auto-Generated-Certificates/operation/get_autossl_check_schedule" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_autossl_check_schedule" id="operation/get_autossl_check_schedule" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-Generated-Certificates/operation/get_autossl_check_schedule" aria-label="tag/Auto-Generated-Certificates/operation/get_autossl_check_schedule"></a>Return AutoSSL check script cron entry<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the cron entry for the <code>autossl_check.pl</code> AutoSSL certificate check script.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the cron entry for the <code>autossl_check.pl</code> AutoSSL certificate check script.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_autossl_check_schedule</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_autossl_check_schedule</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R993jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R993jda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R993jda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R993jda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R993jda:0" aria-labelledby="tab:R993jda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_autossl_check_schedule
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R993jda:1" aria-labelledby="tab:R993jda: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:R9p3jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p3jda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p3jda:0" aria-labelledby="tab:R9p3jda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cron"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"54 1 * * *"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"next_time"</span>: <span class="token string">"2016-06-09T06:00:00.000Z"</span></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">"command"</span>: <span class="token string">"get_autossl_check_schedule"</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/Auto-Generated-Certificates/operation/get_autossl_log" data-section-id="tag/Auto-Generated-Certificates/operation/get_autossl_log" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_autossl_log" id="operation/get_autossl_log" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-Generated-Certificates/operation/get_autossl_log" aria-label="tag/Auto-Generated-Certificates/operation/get_autossl_log"></a>Return AutoSSL log file's contents<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the contents of an AutoSSL log file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the contents of an AutoSSL log 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="start_time" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">start_time</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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-8601 Date Time<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">start_time=2016-06-09T14:25:37Z</span></div><div><div html="<p>When the system created the log file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>When the system created the log 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_autossl_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_autossl_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:R994jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R994jda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R994jda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R994jda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R994jda:0" aria-labelledby="tab:R994jda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_autossl_log <span class="token punctuation">\</span>
<span class="token assign-left variable">start_time</span><span class="token operator">=</span><span class="token string">'2016-06-09T14:25:37Z'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R994jda:1" aria-labelledby="tab:R994jda: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:R9p4jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p4jda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p4jda:0" aria-labelledby="tab:R9p4jda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"contents"</span>: <span class="token string">"This system has AutoSSL set to use cPanel (powered by Sectigo)."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"indent"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"partial"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pid"</span>: <span class="token number">29189</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timestamp"</span>: <span class="token string">"2016-06-09T14:25:37Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"out"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_autossl_log"</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/Auto-Generated-Certificates/operation/get_autossl_logs_catalog" data-section-id="tag/Auto-Generated-Certificates/operation/get_autossl_logs_catalog" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_autossl_logs_catalog" id="operation/get_autossl_logs_catalog" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-Generated-Certificates/operation/get_autossl_logs_catalog" aria-label="tag/Auto-Generated-Certificates/operation/get_autossl_logs_catalog"></a>Return AutoSSL log files<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the AutoSSL feature&#39;s log files.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the AutoSSL feature's log 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_autossl_logs_catalog</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_autossl_logs_catalog</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R995jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R995jda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R995jda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R995jda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R995jda:0" aria-labelledby="tab:R995jda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_autossl_logs_catalog
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R995jda:1" aria-labelledby="tab:R995jda: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:R9p5jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p5jda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p5jda:0" aria-labelledby="tab:R9p5jda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"in_progress"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider"</span>: <span class="token string">"cPanel"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_time"</span>: <span class="token string">"2016-06-09T14:25:37.000Z"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_autossl_logs_catalog"</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/Auto-Generated-Certificates/operation/get_autossl_metadata" data-section-id="tag/Auto-Generated-Certificates/operation/get_autossl_metadata" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_autossl_metadata" id="operation/get_autossl_metadata" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-Generated-Certificates/operation/get_autossl_metadata" aria-label="tag/Auto-Generated-Certificates/operation/get_autossl_metadata"></a>Return current user's AutoSSL metadata<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves values for the currently authenticated user&#39;s AutoSSL&#39;s metadata keys.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves values for the currently authenticated user's AutoSSL's metadata keys.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_autossl_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_autossl_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:R996jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R996jda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R996jda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R996jda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R996jda:0" aria-labelledby="tab:R996jda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_autossl_metadata
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996jda:1" aria-labelledby="tab:R996jda: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:R9p6jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p6jda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p6jda:0" aria-labelledby="tab:R9p6jda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"clobber_externally_signed"</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_expiry_coverage_user"</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_user"</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"</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_coverage_reduced_user"</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_user"</span>: <span class="token number">0</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_autossl_renewal_uncovered_domains_user"</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_user"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_autossl_metadata"</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/Auto-Generated-Certificates/operation/get_autossl_user_excluded_domains" data-section-id="tag/Auto-Generated-Certificates/operation/get_autossl_user_excluded_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_autossl_user_excluded_domains" id="operation/get_autossl_user_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-Certificates/operation/get_autossl_user_excluded_domains" aria-label="tag/Auto-Generated-Certificates/operation/get_autossl_user_excluded_domains"></a>Return all AutoSSL-excluded domains<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists an account&#39;s domains the system excludes from AutoSSL.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account's domains the system excludes from AutoSSL.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><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 cPanel user&#39;s account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel user's 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_autossl_user_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_autossl_user_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:R997jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R997jda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R997jda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R997jda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R997jda:0" aria-labelledby="tab:R997jda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_autossl_user_excluded_domains <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:R997jda:1" aria-labelledby="tab:R997jda: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:R9p7jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p7jda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p7jda:0" aria-labelledby="tab:R9p7jda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"cpcalendars.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">"metadata"</span>: <button class="collapser" aria-label="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">"get_autossl_user_excluded_domains"</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/Auto-Generated-Certificates/operation/get_autossl_providers" data-section-id="tag/Auto-Generated-Certificates/operation/get_autossl_providers" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_autossl_providers" id="operation/get_autossl_providers" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-Generated-Certificates/operation/get_autossl_providers" aria-label="tag/Auto-Generated-Certificates/operation/get_autossl_providers"></a>Return available AutoSSL providers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists available AutoSSL providers on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists available AutoSSL providers on the 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_autossl_providers</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_autossl_providers</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R998jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R998jda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R998jda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R998jda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R998jda:0" aria-labelledby="tab:R998jda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_autossl_providers
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R998jda:1" aria-labelledby="tab:R998jda: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:R9p8jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p8jda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p8jda:0" aria-labelledby="tab:R9p8jda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"Sectigo"</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">"module_name"</span>: <span class="token string">"cPanel"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"specs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"AVERAGE_DELIVERY_TIME"</span>: <span class="token number">120</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DCV_METHODS"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"http"</span>,</div></li><li><div class="hoverable "><span class="token string">"dns"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DELIVERY_METHOD"</span>: <span class="token string">"queue"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HTTP_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">"MAX_DOMAINS_PER_CERTIFICATE"</span>: <span class="token number">1000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"RATE_LIMIT_CERTIFICATES_PER_REGISTERED_DOMAIN_PER_WEEK"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"SUPPORTS_ANCESTOR_DCV"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"SUPPORTS_WILDCARD"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"VALIDITY_PERIOD"</span>: <span class="token number">7776000</span></div></li></ul><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">"display_name"</span>: <span class="token string">"Let’s Encrypt™"</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">"module_name"</span>: <span class="token string">"LetsEncrypt"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"specs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"AVERAGE_DELIVERY_TIME"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DCV_METHODS"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"http"</span>,</div></li><li><div class="hoverable "><span class="token string">"dns"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"DELIVERY_METHOD"</span>: <span class="token string">"api"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"HTTP_DCV_MAX_REDIRECTS"</span>: <span class="token number">10</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"MAX_DOMAINS_PER_CERTIFICATE"</span>: <span class="token number">100</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"RATE_LIMIT_CERTIFICATES_PER_REGISTERED_DOMAIN_PER_WEEK"</span>: <span class="token number">50</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"SUPPORTS_ANCESTOR_DCV"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"SUPPORTS_WILDCARD"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"VALIDITY_PERIOD"</span>: <span class="token number">7776000</span></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_account_id"</span>: <span class="token string">"</span><a href="https://acme-v01.api.letsencrypt.org/acme/reg/12345678">https://acme-v01.api.letsencrypt.org/acme/reg/12345678</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_terms_of_service"</span>: <span class="token string">"</span><a href="https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf">https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_terms_of_service_accepted"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_autossl_providers"</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/Auto-Generated-Certificates/operation/start_autossl_check_for_one_user" data-section-id="tag/Auto-Generated-Certificates/operation/start_autossl_check_for_one_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/start_autossl_check_for_one_user" id="operation/start_autossl_check_for_one_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-Generated-Certificates/operation/start_autossl_check_for_one_user" aria-label="tag/Auto-Generated-Certificates/operation/start_autossl_check_for_one_user"></a>Start cPanel account AutoSSL check<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function performs an AutoSSL certificate check in the background for a cPanel user.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function performs an AutoSSL certificate check in the background for a cPanel 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="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 cPanel username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/start_autossl_check_for_one_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/start_autossl_check_for_one_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:R999jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R999jda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R999jda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R999jda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R999jda:0" aria-labelledby="tab:R999jda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
start_autossl_check_for_one_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>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R999jda:1" aria-labelledby="tab:R999jda: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:R9p9jda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p9jda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p9jda:0" aria-labelledby="tab:R9p9jda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 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">"metadata"</span>: <button class="collapser" aria-label="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">"start_autossl_check_for_one_user"</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/Auto-Generated-Certificates/operation/remove_autossl_user_excluded_domains" data-section-id="tag/Auto-Generated-Certificates/operation/remove_autossl_user_excluded_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/remove_autossl_user_excluded_domains" id="operation/remove_autossl_user_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-Certificates/operation/remove_autossl_user_excluded_domains" aria-label="tag/Auto-Generated-Certificates/operation/remove_autossl_user_excluded_domains"></a>Remove AutoSSL for domain<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables AutoSSL for an account&#39;s specified domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables AutoSSL for an account's specified 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=""><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=cpcalendars.example.com&domain-2=cpcontacts.example.com</span> -<!-- --> <!-- -->Enable AutoSSL for multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=cpcalendars.example.com</span> -<!-- --> <!-- -->Enable AutoSSL for a single domain.</li></ul><div><div html="<p>Enable AutoSSL for this domain.</p>
<p><strong>Note:</strong></p>
<p>For multiple domains, increment the parameter name. For example, domain-1, domain-2, and domain-3.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Enable AutoSSL for this domain.</p>
<p><strong>Note:</strong></p>
<p>For multiple domains, increment the parameter name. For example, domain-1, domain-2, and domain-3.</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=username</span></div><div><div html="<p>The cPanel user&#39;s account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel user's 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="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">/remove_autossl_user_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remove_autossl_user_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:R99ajda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ajda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ajda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ajda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ajda:0" aria-labelledby="tab:R99ajda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remove_autossl_user_excluded_domains <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">domain</span><span class="token operator">=</span><span class="token string">'cpcalendars.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ajda:1" aria-labelledby="tab:R99ajda: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:R9pajda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pajda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pajda:0" aria-labelledby="tab:R9pajda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"remove_autossl_user_excluded_domains"</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/Auto-Generated-Certificates/operation/set_autossl_metadata_key" data-section-id="tag/Auto-Generated-Certificates/operation/set_autossl_metadata_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_autossl_metadata_key" id="operation/set_autossl_metadata_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-Generated-Certificates/operation/set_autossl_metadata_key" aria-label="tag/Auto-Generated-Certificates/operation/set_autossl_metadata_key"></a>Update AutoSSL metadata via JSON<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets values for AutoSSL&#39;s metadata keys. This allows you to replace certificates that AutoSSL did not issue and toggle other AutoSSL notifications.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function performs the same actions as the WHM API 1 <code>set_autossl_metadata</code> function. However, this function accepts a single key and value pair as a parameter instead of JSON. Additionally, you can <strong>only</strong> enter one key and value pair per function call.</li>
<li>This function <strong>only</strong> accepts a single key and value pair. To set all values, use the WHM API 1 <code>set_autossl_metadata</code> function or make multiple calls to this function.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets values for AutoSSL's metadata keys. This allows you to replace certificates that AutoSSL did not issue and toggle other AutoSSL notifications.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function performs the same actions as the WHM API 1 <code>set_autossl_metadata</code> function. However, this function accepts a single key and value pair as a parameter instead of JSON. Additionally, you can <strong>only</strong> enter one key and value pair per function call.</li>
<li>This function <strong>only</strong> accepts a single key and value pair. To set all values, use the WHM API 1 <code>set_autossl_metadata</code> function or make multiple calls to 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="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></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"clobber_externally_signed"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"notify_autossl_expiry"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"notify_autossl_expiry_coverage"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"notify_autossl_expiry_coverage_user"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"notify_autossl_renewal"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"notify_autossl_renewal_user"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"notify_autossl_renewal_coverage"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"notify_autossl_renewal_coverage_user"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"notify_autossl_renewal_coverage_reduced"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"notify_autossl_renewal_coverage_reduced_user"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"notify_autossl_renewal_uncovered_domains"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"notify_autossl_renewal_uncovered_domains_user"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=notify_autossl_expiry</span></div><div><div html="<p>The AutoSSL metadata key that you wish to modify.</p>
<ul>
<li><code>clobber_externally_signed</code> — Whether to allow AutoSSL to replace certificates that none of this system’s AutoSSL modules issued. When you enable this option, AutoSSL will install certificates that replace users’ Certificate Authority (CA) issued certificates if they are invalid or expire within three days.</li>
<li><code>notify_autossl_expiry</code> — Whether to send a notification when an AutoSSL certificate expires. This occurs when AutoSSL cannot request a new certificate.</li>
<li><code>notify_autossl_expiry_coverage</code> — Whether to send a notification if at least one currently-secured domain will lose coverage when the certificate renews.</li>
<li><code>notify_autossl_expiry_coverage_user </code>— Whether to send a notification if at least one currently-secured domain for a user will lose coverage when the certificate renews.</li>
<li><code>notify_autossl_renewal</code> — Whether to send a notification when AutoSSL successfully renews a certificate.</li>
<li><code>notify_autossl_renewal_user</code> — Whether to send a notification when AutoSSL successfully renews a certificate for a user.</li>
<li><code>notify_autossl_renewal_coverage</code> — Whether to send a notification when a currently-secured domain fails DCV and the certificate has not reached its renewal period.</li>
<li><code>notify_autossl_renewal_coverage_user</code> — Whether to send a notification when a user&#39;s currently-secured domain fails DCV and the certificate has not reached its renewal period.</li>
<li><code>notify_autossl_renewal_coverage_reduced</code> — Whether to send a notification when AutoSSL has renewed a certificate, but the new certificate lacks at least one domain that the previous certificate secured.</li>
<li><code>notify_autossl_renewal_coverage_reduced_user</code> — Whether to send a notification when AutoSSL has renewed a certificate for a user, but the new certificate lacks at least one domain that the previous certificate secured.</li>
<li><code>notify_autossl_renewal_uncovered_domains</code> — Whether to send a notification when AutoSSL has renewed a certificate, but the new certificate lacks one or more of the website’s domains.</li>
<li><code>notify_autossl_renewal_uncovered_domains_user</code> — Whether to send a notification when AutoSSL has renewed a certificate, but the new certificate lacks one or more of the website’s domains.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The AutoSSL metadata key that you wish to modify.</p>
<ul>
<li><code>clobber_externally_signed</code> — Whether to allow AutoSSL to replace certificates that none of this system’s AutoSSL modules issued. When you enable this option, AutoSSL will install certificates that replace users’ Certificate Authority (CA) issued certificates if they are invalid or expire within three days.</li>
<li><code>notify_autossl_expiry</code> — Whether to send a notification when an AutoSSL certificate expires. This occurs when AutoSSL cannot request a new certificate.</li>
<li><code>notify_autossl_expiry_coverage</code> — Whether to send a notification if at least one currently-secured domain will lose coverage when the certificate renews.</li>
<li><code>notify_autossl_expiry_coverage_user </code>— Whether to send a notification if at least one currently-secured domain for a user will lose coverage when the certificate renews.</li>
<li><code>notify_autossl_renewal</code> — Whether to send a notification when AutoSSL successfully renews a certificate.</li>
<li><code>notify_autossl_renewal_user</code> — Whether to send a notification when AutoSSL successfully renews a certificate for a user.</li>
<li><code>notify_autossl_renewal_coverage</code> — Whether to send a notification when a currently-secured domain fails DCV and the certificate has not reached its renewal period.</li>
<li><code>notify_autossl_renewal_coverage_user</code> — Whether to send a notification when a user's currently-secured domain fails DCV and the certificate has not reached its renewal period.</li>
<li><code>notify_autossl_renewal_coverage_reduced</code> — Whether to send a notification when AutoSSL has renewed a certificate, but the new certificate lacks at least one domain that the previous certificate secured.</li>
<li><code>notify_autossl_renewal_coverage_reduced_user</code> — Whether to send a notification when AutoSSL has renewed a certificate for a user, but the new certificate lacks at least one domain that the previous certificate secured.</li>
<li><code>notify_autossl_renewal_uncovered_domains</code> — Whether to send a notification when AutoSSL has renewed a certificate, but the new certificate lacks one or more of the website’s domains.</li>
<li><code>notify_autossl_renewal_uncovered_domains_user</code> — Whether to send a notification when AutoSSL has renewed a certificate, but the new certificate lacks one or more of the website’s domains.</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><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">value=1</span></div><div><div html="<p>Whether to allow AutoSSL to replace certificates that it did not issue for the <code>clobber_externally_signed</code> parameter.</p>
<p><strong>or</strong></p>
<p>Whether to send a notification for the <code>notify_autossl_expiry</code>, <code>notify_autossl_expiry_coverage</code>, <code>notify_autossl_expiry_coverage_user</code>, <code>notify_autossl_renewal</code>, <code>notify_autossl_renewal_user</code>, <code>notify_autossl_renewal_coverage</code>, <code>notify_autossl_renewal_coverage</code>, <code>notify_autossl_renewal_coverage_reduced</code>, <code>notify_autossl_renewal_coverage_reduced_user</code>, <code>notify_autossl_renewal_uncovered_domains</code>, and <code>notify_autossl_renewal_uncovered_domains_user</code> parameters.</p>
<ul>
<li><code>1</code> — Allow or notify.</li>
<li><code>0</code> — Do <strong>not</strong> allow or notify.</li>
</ul>
<p><strong>Note:</strong></p>
<p> For reference, the system preconfigures AutoSSL metadata keys to the following values:</p>
<ul>
<li>The value for <code>clobber_externally_signed</code> defaults to <code>0</code>.</li>
<li>The value for <code>notify_autossl_expiry</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_expiry_coverage</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_expiry_coverage_user</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal_user</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal_coverage</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal_coverage_user</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal_coverage_reduced</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal_coverage_reduced_user</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal_uncovered_domains</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal_uncovered_domains_user</code> defaults to <code>1</code>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow AutoSSL to replace certificates that it did not issue for the <code>clobber_externally_signed</code> parameter.</p>
<p><strong>or</strong></p>
<p>Whether to send a notification for the <code>notify_autossl_expiry</code>, <code>notify_autossl_expiry_coverage</code>, <code>notify_autossl_expiry_coverage_user</code>, <code>notify_autossl_renewal</code>, <code>notify_autossl_renewal_user</code>, <code>notify_autossl_renewal_coverage</code>, <code>notify_autossl_renewal_coverage</code>, <code>notify_autossl_renewal_coverage_reduced</code>, <code>notify_autossl_renewal_coverage_reduced_user</code>, <code>notify_autossl_renewal_uncovered_domains</code>, and <code>notify_autossl_renewal_uncovered_domains_user</code> parameters.</p>
<ul>
<li><code>1</code> — Allow or notify.</li>
<li><code>0</code> — Do <strong>not</strong> allow or notify.</li>
</ul>
<p><strong>Note:</strong></p>
<p> For reference, the system preconfigures AutoSSL metadata keys to the following values:</p>
<ul>
<li>The value for <code>clobber_externally_signed</code> defaults to <code>0</code>.</li>
<li>The value for <code>notify_autossl_expiry</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_expiry_coverage</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_expiry_coverage_user</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal_user</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal_coverage</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal_coverage_user</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal_coverage_reduced</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal_coverage_reduced_user</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal_uncovered_domains</code> defaults to <code>1</code>.</li>
<li>The value for <code>notify_autossl_renewal_uncovered_domains_user</code> defaults to <code>1</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="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">/set_autossl_metadata_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_autossl_metadata_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:R99bjda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99bjda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99bjda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99bjda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99bjda:0" aria-labelledby="tab:R99bjda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_autossl_metadata_key <span class="token punctuation">\</span>
<span class="token assign-left variable">key</span><span class="token operator">=</span><span class="token string">'notify_autossl_expiry'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">value</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:R99bjda:1" aria-labelledby="tab:R99bjda: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:R9pbjda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pbjda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pbjda:0" aria-labelledby="tab:R9pbjda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_autossl_metadata_key"</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/Auto-Generated-Certificates/operation/set_autossl_provider" data-section-id="tag/Auto-Generated-Certificates/operation/set_autossl_provider" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_autossl_provider" id="operation/set_autossl_provider" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-Generated-Certificates/operation/set_autossl_provider" aria-label="tag/Auto-Generated-Certificates/operation/set_autossl_provider"></a>Update the AutoSSL provider<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the provider that the AutoSSL feature uses.</p>
<p><strong>Note:</strong></p>
<p> To disable AutoSSL, call WHM API 1&#39;s <code>disable_autossl</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the provider that the AutoSSL feature uses.</p>
<p><strong>Note:</strong></p>
<p> To disable AutoSSL, call WHM API 1's <code>disable_autossl</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="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=cPanel</span></div><div><div html="<p>The AutoSSL provider&#39;s name. For example:</p>
<ul>
<li><code>cPanel</code></li>
<li><code>LetsEncrypt</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The AutoSSL provider's name. For example:</p>
<ul>
<li><code>cPanel</code></li>
<li><code>LetsEncrypt</code></li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="x_*" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">x_*</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">x_*=(varies)</span></div><div><div html="<p>Additional parameters which you wish to pass to the AutoSSL provider.</p>
<p> <strong>Note:</strong></p>
<p> These additional parameters begin with the <code>x_</code> prefix. For example, the Let&#39;s Encrypt provider accepts the <code>x_terms_of_service_accepted parameter</code>, to which you would pass the URL of the terms of service that you accept.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Additional parameters which you wish to pass to the AutoSSL provider.</p>
<p> <strong>Note:</strong></p>
<p> These additional parameters begin with the <code>x_</code> prefix. For example, the Let's Encrypt provider accepts the <code>x_terms_of_service_accepted parameter</code>, to which you would pass the URL of the terms of service that you accept.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/set_autossl_provider</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_autossl_provider</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99cjda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99cjda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99cjda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99cjda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99cjda:0" aria-labelledby="tab:R99cjda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_autossl_provider <span class="token punctuation">\</span>
<span class="token assign-left variable">provider</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:R99cjda:1" aria-labelledby="tab:R99cjda: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:R9pcjda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pcjda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pcjda:0" aria-labelledby="tab:R9pcjda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_autossl_provider"</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/Auto-Generated-Certificates/operation/set_autossl_metadata" data-section-id="tag/Auto-Generated-Certificates/operation/set_autossl_metadata" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_autossl_metadata" id="operation/set_autossl_metadata" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-Generated-Certificates/operation/set_autossl_metadata" aria-label="tag/Auto-Generated-Certificates/operation/set_autossl_metadata"></a>Update AutoSSL metadata<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets values for AutoSSL&#39;s metadata keys. This allows you to replace certificates that AutoSSL did not issue and toggle other AutoSSL notifications.</p>
<p><strong>Note:</strong></p>
<p>We recommend that you use the WHM API 1 <code>set_autossl_metadata_key</code> function instead.</p>
<p><strong>Information:</strong></p>
<ul>
<li>You can enter more than one key and value pair in the <code>metadata_json</code> JSON hash.</li>
<li>Any keys that you do not <strong>explicitly</strong> define will adopt the system&#39;s default value.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets values for AutoSSL's metadata keys. This allows you to replace certificates that AutoSSL did not issue and toggle other AutoSSL notifications.</p>
<p><strong>Note:</strong></p>
<p>We recommend that you use the WHM API 1 <code>set_autossl_metadata_key</code> function instead.</p>
<p><strong>Information:</strong></p>
<ul>
<li>You can enter more than one key and value pair in the <code>metadata_json</code> JSON hash.</li>
<li>Any keys that you do not <strong>explicitly</strong> define will adopt the system's default value.</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="metadata_json" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand metadata_json"><span class="property-name">metadata_json</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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">metadata_json={"clobber_externally_signed":1,"notify_autossl_expiry":1,"notify_autossl_expiry_coverage":1,"notify_autossl_expiry_coverage_user":1,"notify_autossl_expiry_user":1,"notify_autossl_renewal":1,"notify_autossl_renewal_coverage":1,"notify_autossl_renewal_coverage_reduced":1,"notify_autossl_renewal_coverage_reduced_user":1,"notify_autossl_renewal_coverage_user":1,"notify_autossl_renewal_uncovered_domains":1,"notify_autossl_renewal_uncovered_domains_user":1,"notify_autossl_renewal_user":1}</span></div><div><div html="<p>JSON-encoded object of metadata keys and values that control AutoSSL&#39;s behavior.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>JSON-encoded object of metadata keys and values that control AutoSSL's behavior.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/set_autossl_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_autossl_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:R99djda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99djda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99djda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99djda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99djda:0" aria-labelledby="tab:R99djda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_autossl_metadata <span class="token punctuation">\</span>
<span class="token assign-left variable">metadata_json</span><span class="token operator">=</span><span class="token string">'{"clobber_externally_signed":"1","notify_autossl_expiry":"1","notify_autossl_expiry_coverage":"1","notify_autossl_expiry_coverage_user":"1","notify_autossl_expiry_user":"1","notify_autossl_renewal":"1","notify_autossl_renewal_coverage":"1","notify_autossl_renewal_coverage_reduced":"1","notify_autossl_renewal_coverage_reduced_user":"1","notify_autossl_renewal_coverage_user":"1","notify_autossl_renewal_uncovered_domains":"1","notify_autossl_renewal_uncovered_domains_user":"1","notify_autossl_renewal_user":"1"}'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99djda:1" aria-labelledby="tab:R99djda: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:R9pdjda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pdjda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pdjda:0" aria-labelledby="tab:R9pdjda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_autossl_metadata"</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/Auto-Generated-Certificates/operation/set_autossl_user_excluded_domains" data-section-id="tag/Auto-Generated-Certificates/operation/set_autossl_user_excluded_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_autossl_user_excluded_domains" id="operation/set_autossl_user_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-Certificates/operation/set_autossl_user_excluded_domains" aria-label="tag/Auto-Generated-Certificates/operation/set_autossl_user_excluded_domains"></a>Disable AutoSSL for domain<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function disables AutoSSL for a specific domain on an account.</p>
<p><strong>Warning:</strong></p>
<p> This function <strong>replaces</strong> the list of any previously-excluded domains. To add a domain to the list of the user&#39;s excluded domains, use the <code>add_autossl_user_excluded_domains</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables AutoSSL for a specific domain on an account.</p>
<p><strong>Warning:</strong></p>
<p> This function <strong>replaces</strong> the list of any previously-excluded domains. To add a domain to the list of the user's excluded domains, use the <code>add_autossl_user_excluded_domains</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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>Disable AutoSSL for this domain. If you do <strong>not</strong> include this parameter, the system will <strong>enable</strong> AutoSSL for every domain on the account.</p>
<p><strong>Note</strong></p>
<p>To disable AutoSSL for 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>Disable AutoSSL for this domain. If you do <strong>not</strong> include this parameter, the system will <strong>enable</strong> AutoSSL for every domain on the account.</p>
<p><strong>Note</strong></p>
<p>To disable AutoSSL for 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><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 cPanel user&#39;s account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel user's 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="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">/set_autossl_user_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/set_autossl_user_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:R99ejda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ejda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ejda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ejda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ejda:0" aria-labelledby="tab:R99ejda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
set_autossl_user_excluded_domains <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:R99ejda:1" aria-labelledby="tab:R99ejda: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:R9pejda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pejda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pejda:0" aria-labelledby="tab:R9pejda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"set_autossl_user_excluded_domains"</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/Auto-Generated-Certificates/operation/start_autossl_check_for_all_users" data-section-id="tag/Auto-Generated-Certificates/operation/start_autossl_check_for_all_users" class="sc-dntaoT ceciOs"><div data-section-id="operation/start_autossl_check_for_all_users" id="operation/start_autossl_check_for_all_users" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-Generated-Certificates/operation/start_autossl_check_for_all_users" aria-label="tag/Auto-Generated-Certificates/operation/start_autossl_check_for_all_users"></a>Start AutoSSL check for all cPanel accounts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function performs an AutoSSL certificate check in the background for all cPanel users that have the feature enabled.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function performs an AutoSSL certificate check in the background for all cPanel users that have the feature 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/start_autossl_check_for_all_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/start_autossl_check_for_all_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:R99fjda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99fjda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99fjda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99fjda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99fjda:0" aria-labelledby="tab:R99fjda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
start_autossl_check_for_all_users
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99fjda:1" aria-labelledby="tab:R99fjda: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:R9pfjda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pfjda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pfjda:0" aria-labelledby="tab:R9pfjda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 number">29193</span></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">"command"</span>: <span class="token string">"start_autossl_check_for_all_users"</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/Auto-Generated-Certificates/operation/reset_autossl_provider" data-section-id="tag/Auto-Generated-Certificates/operation/reset_autossl_provider" class="sc-dntaoT ceciOs"><div data-section-id="operation/reset_autossl_provider" id="operation/reset_autossl_provider" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-Generated-Certificates/operation/reset_autossl_provider" aria-label="tag/Auto-Generated-Certificates/operation/reset_autossl_provider"></a>Restore AutoSSL registration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function resets the AutoSSL registration with a remote AutoSSL provider.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function resets the AutoSSL registration with a remote AutoSSL 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=cPanel</span></div><div><div html="<p>The AutoSSL provider&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The AutoSSL provider's name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="x_*" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">x_*</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">x_*=(varies)</span></div><div><div html="<p>Additional parameters which you wish to pass to the AutoSSL provider.</p>
<p><strong>Note:</strong></p>
<p> These additional parameters begin with the <code>x_</code> prefix.
For example, the Let&#39;s Encrypt provider accepts the <code>x_terms_of_service_accepted</code> parameter,
to which you would pass the URL of the terms of service that you accept.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Additional parameters which you wish to pass to the AutoSSL provider.</p>
<p><strong>Note:</strong></p>
<p> These additional parameters begin with the <code>x_</code> prefix.
For example, the Let's Encrypt provider accepts the <code>x_terms_of_service_accepted</code> parameter,
to which you would pass the URL of the terms of service that you accept.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/reset_autossl_provider</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/reset_autossl_provider</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99gjda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99gjda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99gjda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99gjda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99gjda:0" aria-labelledby="tab:R99gjda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
reset_autossl_provider <span class="token punctuation">\</span>
<span class="token assign-left variable">provider</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:R99gjda:1" aria-labelledby="tab:R99gjda: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:R9pgjda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pgjda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pgjda:0" aria-labelledby="tab:R9pgjda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"reset_autossl_provider"</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/cPanel-Account-Settings" data-section-id="tag/cPanel-Account-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/cPanel-Account-Settings" aria-label="tag/cPanel-Account-Settings"></a>cPanel Account Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>SSL Certificates / cPanel Account Settings</p>
"><p>SSL Certificates / cPanel Account Settings</p>
</div></div></div><div id="tag/cPanel-Account-Settings/operation/fetchcrtinfo" data-section-id="tag/cPanel-Account-Settings/operation/fetchcrtinfo" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetchcrtinfo" id="operation/fetchcrtinfo" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Settings/operation/fetchcrtinfo" aria-label="tag/cPanel-Account-Settings/operation/fetchcrtinfo"></a>Return SSL certificate information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves information about a certificate.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves information about a 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="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_bf638_f81af_1500191700_79e34f42c83f748bd49474ab9d66f7cd</span></div><div><div html="<p>The certificate&#39;s internal system ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate's internal system ID.</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=username</span></div><div><div html="<p>The cPanel account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/fetchcrtinfo</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/fetchcrtinfo</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4khlda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4khlda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4khlda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4khlda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4khlda:0" aria-labelledby="tab:R4khlda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
fetchcrtinfo <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username'</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_bf638_f81af_1500191700_79e34f42c83f748bd49474ab9d66f7cd'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4khlda:1" aria-labelledby="tab:R4khlda: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:R4shlda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4shlda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4shlda:0" aria-labelledby="tab:R4shlda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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-----\nMIIEkjCCA3qgAwIBAgIQCgFBQgAAAVOFc2oLheynCDANBgkqhkiG9w0BAQsFADA/MSQwIgYDVQQK\nExtEaWdpdGFsIFNpZ25hdHVyZSBUcnVzdCBDby4xFzAVBgNVBAMTDkRTVCBSb290IENBIFgzMB4X\nDTE2MDMxNzE2NDA0NloXDTIxMDMxNzE2NDA0NlowSjELMAkGA1UEBhMCVVMxFjAUBgNVBAoTDUxl\ndCdzIEVuY3J5cHQxIzAhBgNVBAMTGkxldCdzIEVuY3J5cHQgQXV0aG9yaXR5IFgzMIIBIjANBgkq\nhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnNMM8FrlLke3cl03g7NoYzDq1zUmGSXhvb418XCSL7e4\nS0EFq6meNQhY7LEqxGiHC6PjdeTm86dicbp5gWAf15Gan/PQeGdxyGkOlZHP/uaZ6WA8SMx+yk13\nEiSdRxta67nsHjcAHJyse6cF6s5K671B5TaYucv9bTyWaN8jKkKQDIZ0Z8h/pZq4UmEUEz9l6YKH\ny9v6Dlb2honzhT+Xhq+w3Brvaw2VFn3EK6BlspkENnWAa6xK8xuQSXgvopZPKiAlKQTGdMDQMc2P\nMTiVFrqoM7hD8bEfwzB/onkxEz0tNvjj/PIzark5McWvxI0NHWQWM6r6hCm21AvA2H3DkwIDAQAB\no4IBfTCCAXkwEgYDVR0TAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwfwYIKwYBBQUHAQEE\nczBxMDIGCCsGAQUFBzABhiZodHRwOi8vaXNyZy50cnVzdGlkLm9jc3AuaWRlbnRydXN0LmNvbTA7\nBggrBgEFBQcwAoYvaHR0cDovL2FwcHMuaWRlbnRydXN0LmNvbS9yb290cy9kc3Ryb290Y2F4My5w\nN2MwHwYDVR0jBBgwFoAUxKexpHsscfrb4UuQdf/EFWCFiRAwVAYDVR0gBE0wSzAIBgZngQwBAgEw\nPwYLKwYBBAGC3xMBAQEwMDAuBggrBgEFBQcCARYiaHR0cDovL2Nwcy5yb290LXgxLmxldHNlbmNy\neXB0Lm9yZzA8BgNVHR8ENTAzMDGgL6AthitodHRwOi8vY3JsLmlkZW50cnVzdC5jb20vRFNUUk9P\nVENBWDNDUkwuY3JsMB0GA1UdDgQWBBSoSmpjBH3duubRObemRWXv86jsoTANBgkqhkiG9w0BAQsF\nAAOCAQEA3TPXEfNjWDjdGBX7CVW+dla5cEilaUcne8IkCJLxWh9KEik3JHRRHGJouM2VcGfl96S8\nTihRzZvoroed6ti6WqEBmtzw3Wodatg+VyOeph4EYpr/1wXKtx8/wApIvJSwtmVi4MFU5aMqrSDE\n6ea73Mj2tcMyo5jMd6jmeWUHK8so/joWUoHOUgwuX4Po1QYz+3dszkDqMp4fklxBwXRsW10KXzPM\nTZ+sOPAveyxindmjkW8lGy+QsRlGPfZ+G6Z6h7mjem0Y+iWlkYcV4PIWL1iwBi8saCbGS5jN2p8M\n+X+Q7UNKEkROb3N6KOqkqm57TH2H3eDJAkSnh6/DNFu0Qg==\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-----\nMIIGeDCCBWCgAwIBAgISAxs2uBW3Q2TrGS/aRjTFh90EMA0GCSqGSIb3DQEBCwUAMEoxCzAJBgNV\nBAYTAlVTMRYwFAYDVQQKEw1MZXQncyBFbmNyeXB0MSMwIQYDVQQDExpMZXQncyBFbmNyeXB0IEF1\ndGhvcml0eSBYMzAeFw0xNzA0MTcwNzU1MDBaFw0xNzA3MTYwNzU1MDBaMCUxIzAhBgNVBAMTGm9u\nZWFkYXl1bnRpbHRoZWRheWlkaWUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\nv2OGaQw5oeg2hy0LqfYlBoncBPqElkTfZGqY/2WHoKr5TawPqOlsrLzx17946KGxLs0A3J1rRpi9\nOqrHdv69tj2pFRFC1USjlQmWnUi3h//aTYFNrfDmG+lNWZQ3ALCveTQXYIAvbmwLSPxh6wdtEmU0\nGjbqDNxsI8GSrZcJ543PSTXYFvp7S1yBNSn64S5QB8WeNkLGyF0G+ieXbCJo5neJrNh6+6U+x7mT\n/VBsQDOFOMIskjKo1q56+/elzgSi6lZ5w9IXuQRB3YbbWzCC/kFmzEB/NTe9R5v1AEzdcNwWXpfi\nvlrNIktLQDYIRyHqtyrXl3uR8fvmoYf0ll+BrwIDAQABo4IDezCCA3cwDgYDVR0PAQH/BAQDAgWg\nMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMBAf8EAjAAMB0GA1UdDgQWBBQW\ns0hUTrAJo+db1I2D9K2Aa2O3STAfBgNVHSMEGDAWgBSoSmpjBH3duubRObemRWXv86jsoTBwBggr\nBgEFBQcBAQRkMGIwLwYIKwYBBQUHMAGGI2h0dHA6Ly9vY3NwLmludC14My5sZXRzZW5jcnlwdC5v\ncmcvMC8GCCsGAQUFBzAChiNodHRwOi8vY2VydC5pbnQteDMubGV0c2VuY3J5cHQub3JnLzCCAYMG\nA1UdEQSCAXowggF2giFjcGFuZWwub25lYWRheXVudGlsdGhlZGF5aWRpZS5jb22CH21haWwub25l\nYWRheXVudGlsdGhlZGF5aWRpZS5jb22CHm1wMy5vbmVhZGF5dW50aWx0aGVkYXlpZGllLmNvbYIa\nb25lYWRheXVudGlsdGhlZGF5aWRpZS5jb22CIXJhbmRvbS5vbmVhZGF5dW50aWx0aGVkYXlpZGll\nLmNvbYIid2ViZGlzay5vbmVhZGF5dW50aWx0aGVkYXlpZGllLmNvbYIid2VibWFpbC5vbmVhZGF5\ndW50aWx0aGVkYXlpZGllLmNvbYIed2htLm9uZWFkYXl1bnRpbHRoZWRheWlkaWUuY29tgiJ3d3cu\nbXAzLm9uZWFkYXl1bnRpbHRoZWRheWlkaWUuY29tgh53d3cub25lYWRheXVudGlsdGhlZGF5aWRp\nZS5jb22CJXd3dy5yYW5kb20ub25lYWRheXVudGlsdGhlZGF5aWRpZS5jb20wgf4GA1UdIASB9jCB\n8zAIBgZngQwBAgEwgeYGCysGAQQBgt8TAQEBMIHWMCYGCCsGAQUFBwIBFhpodHRwOi8vY3BzLmxl\ndHNlbmNyeXB0Lm9yZzCBqwYIKwYBBQUHAgIwgZ4MgZtUaGlzIENlcnRpZmljYXRlIG1heSBvbmx5\nIGJlIHJlbGllZCB1cG9uIGJ5IFJlbHlpbmcgUGFydGllcyBhbmQgb25seSBpbiBhY2NvcmRhbmNl\nIHdpdGggdGhlIENlcnRpZmljYXRlIFBvbGljeSBmb3VuZCBhdCBodHRwczovL2xldHNlbmNyeXB0\nLm9yZy9yZXBvc2l0b3J5LzANBgkqhkiG9w0BAQsFAAOCAQEAbfVset/dZ+ru/K2DMa2Od4pCnRYa\nLDREL7TyAWHjHq2fHK1WbzlO9zHis+C0ezB6QBPMnrGDZns/v1njGp1gASly1pqgAsytbQdPbfHv\n/Bx1HRWywniAKSRYFxrc3k3ThrSZxDj+A9mt0znNDNUvRNuP5dGFmQzFACykgNJ58yCeUJZkD78p\n7UjpbpzxWW2m6MHlHu7dDcCwSXpCa6uE4V9TeVs3OSo42C+ZlGH2x3GeZYlOZENmG2nFw0mQFSIW\nATyQuv1Jlc7tiUGmY9o13teTN4YLColMk037Rrwb/mne3ORCPB0k7QtPtzHnCdnRio2NvwZkPXzL\nbioRoW0dQg==\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">0</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-----\nMIIEpAIBAAKCAQEAv2OGaQw5oeg2hy0LqfYlBoncBPqElkTfZGqY/2WHoKr5TawP\nqOlsrLzx17946KGxLs0A3J1rRpi9OqrHdv69tj2pFRFC1USjlQmWnUi3h//aTYFN\nrfDmG+lNWZQ3ALCveTQXYIAvbmwLSPxh6wdtEmU0GjbqDNxsI8GSrZcJ543PSTXY\nFvp7S1yBNSn64S5QB8WeNkLGyF0G+ieXbCJo5neJrNh6+6U+x7mT/VBsQDOFOMIs\nkjKo1q56+/elzgSi6lZ5w9IXuQRB3YbbWzCC/kFmzEB/NTe9R5v1AEzdcNwWXpfi\nvlrNIktLQDYIRyHqtyrXl3uR8fvmoYf0ll+BrwIDAQABAoIBAG6cIm5LtnMwNXNi\nQT91Fmj0+8eU0VPXchQi11GjaAMfTP3q1xIT9c7PVCYQbtxjtncJ29mk0P73/0UM\ntkK7bwEIGdQnKa0AAlp8NCOqhwd+grgQZsiEVTkEWMPQuQkZFBDEXk5TRxZWMx93\nXU/r9smO29HasuHD8mun0BGrHPpJJm6JE8iMT9wIrr4pYb5TLtXtO/yQ5rxsT5uB\nbmuXAHZ51brj+aIdjrYNAVYHPvVDAjs7aHgKjbLvJ7DJPJKSbkbAEYKqT7lyQO5x\nGtLk1K5qKNHc1sFyybBF/LO1Tn7xTMbSuKce/AUvgE76RZ0nkvCD/kY1l3WBH2ns\nYFsojsECgYEA7UgMJgoKnerhmG/mnZqPUXb78PVgZmt0zmlAYRAcLc8K19xPKVOK\nz4HcDmfkPdkpsdp1YXJ6K/ueJOXq0aCFh2E+uYyqvsMQDFp72poxUPPlJ5zoj3jG\n6N9owoV2CuWX0QbhsE4/Hu5sVjBdE8WuqBBUqKp6602YV8YrA018bSkCgYEAznyq\nLhQujrpeqlN/HRhpNne5r5D8F4wQSZmFP9eRP1pnO2TQqY/wXJgOMKT20CcqwiiY\noVuOmQs1W3dz/MlWHanRKL5cIcF26Pgsp1jimD13JwPU/7nH4+CzJmkXGSHbNmQf\n2wvjv+jni2PbTZ5sotESziaJAdbcRAdg39KnexcCgYEAj086dycNbn9ULZs4L+wP\nr2YrmEa7KGCyNZCAH595RXmM1P7smMsqRVXrMJAy29/zPMXyqx5XB4V66FIs1tsa\nir+DANIitgBeCvgDYe5K5tfHiXtNQonxqOh1/zZYKxCr9sUvPiqkGOxrZkrjjHOS\nn1Ltrsj4YHGHF0xK4j3EbrECgYB403ANqJeZwyqTxmoST295hNNuDYvGB5qcRq43\nLl/6z16q3ZJQNj7zH7Ll+hHGubSGipTNjrLBkVJ2pE6FtBalIvKWQdXNltSK/HW8\nswFdDlKDzPU9cquqB5ktN79hYHNSv4H4fluVt6aN5S+1mqd9GpRDdz8iiWS4lgy0\nzCJenwKBgQC61u/GsjGx4yv0c3KJHgrpIroo3HYsamAdjJBfgBGKxrxVO5J7dbvd\n84UYzp+a0XNjazMxx5rEbU3HjKV5nsHjU+Eoqpz/vwfRqbC7mqINrRQoBKtEhuOY\n+xd6W+i58dOPv7PmgxPegmZ4Fo+jHx+mNLv9L+27JPMBRwRWUxH5TQ==\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.0.2.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">"metadata"</span>: <button class="collapser" aria-label="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">"fetchcrtinfo"</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/cPanel-Account-Settings/operation/fetchsslinfo" data-section-id="tag/cPanel-Account-Settings/operation/fetchsslinfo" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetchsslinfo" id="operation/fetchsslinfo" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Settings/operation/fetchsslinfo" aria-label="tag/cPanel-Account-Settings/operation/fetchsslinfo"></a>Return cPanel account SSL certificate information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves information about SSL certificates that you could install for a user. This function does <strong>not</strong> provide information about the currently installed certificates.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves information about SSL certificates that you could install for a user. This function does <strong>not</strong> provide information about the currently installed certificates.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="crtdata" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">crtdata</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">crtdata=-----BEGIN CERTIFICATE-----\nMIIDdzCCAl+gAwIBAgIFAhQDowAwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL\nZXhhbXBsZS5jb20wHhcNMTkxMTExMjAzNzUzWhcNMjAxMTEwMjAzNzUzWjAWMRQw\nEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\nggEBAK31N5qqd4BhMRm318tt7CP3thvJ9nXv5j3Hks8bfNggAgBmWwh/iGEoyB0e\nmKmFkomXYQejSCkFmwI5/I+H53LA1UrnWURAHaY8UCJMMeCe22E9fbmASNMhcnov\n/AOYBl3kEWEkKVBN3dQZFsWzj+PTTui1zHl8nrr1POPLZMS+t8D3HppNoUBwBkKR\nQ/MetqCaQ3HlgbknMi0/5DbuaV0GJNbXNX9uhnGqQFUI21sEVU4xcvtEDN88dT1d\nx5EhLXobDV/brXgFm85QK/lZt3aWlIJLs/WJJSK+152PO3HhfoHpkx+JflMYoev5\nLauXhZGYXCEG8sBLa2PPH9WlpgcCAwEAAaOByzCByDAdBgNVHQ4EFgQU/Vx4Cer1\nmY3SaijxdCsA2Jo7q84wCQYDVR0TBAIwADBCBgNVHSMEOzA5gBT9XHgJ6vWZjdJq\nKPF0KwDYmjurzqEapBgwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb22CBQIUA6MAMB0G\nA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjA5BgNVHREEMjAwggtleGFtcGxl\nLmNvbYIQbWFpbC5leGFtcGxlLmNvbYIPd3d3LmV4YW1wbGUuY29tMA0GCSqGSIb3\nDQEBCwUAA4IBAQCneJA732g7srfydkgG0XJ8b1RS3ffVlnG1ahCDfIpBTx2M7Oco\n0oa4QK4fEJnyh5Zc861aNrRHecLk4KV4QmDmLJVxTKNv3QXqgPJu+zN49x9ESwRs\nbqiaD+K6MYmlyRukxY+v8jyOhTKvZTOjuuGKhDRcNNgn/kPIjZw3v37vY4o1pUPL\nP1YBw2Caa01HstzouaVZlw05Viwo2AHJE5u7zW+VcA4VR8WAD/2SqdyWZIo+chwd\nr3hWlRyHephLCBhOLb1wPk3E+mOIyryXjLpGdVnWewMSEY8AGvv7IORkO5ufCz/c\n5UlG1r1+l5AhnFQPGoREI49hXVAETVInW9Uk\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><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&#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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/fetchsslinfo</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/fetchsslinfo</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kilda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kilda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kilda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kilda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kilda:0" aria-labelledby="tab:R4kilda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
fetchsslinfo
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kilda:1" aria-labelledby="tab:R4kilda: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:R4silda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4silda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4silda:0" aria-labelledby="tab:R4silda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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-----\\nMIIDdzCCAl+gAwIBAgIFAhQDowAwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL\\nZXhhbXBsZS5jb20wHhcNMTkxMTExMjAzNzUzWhcNMjAxMTEwMjAzNzUzWjAWMRQw\\nEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\\nggEBAK31N5qqd4BhMRm318tt7CP3thvJ9nXv5j3Hks8bfNggAgBmWwh/iGEoyB0e\\nmKmFkomXYQejSCkFmwI5/I+H53LA1UrnWURAHaY8UCJMMeCe22E9fbmASNMhcnov\\n/AOYBl3kEWEkKVBN3dQZFsWzj+PTTui1zHl8nrr1POPLZMS+t8D3HppNoUBwBkKR\\nQ/MetqCaQ3HlgbknMi0/5DbuaV0GJNbXNX9uhnGqQFUI21sEVU4xcvtEDN88dT1d\\nx5EhLXobDV/brXgFm85QK/lZt3aWlIJLs/WJJSK+152PO3HhfoHpkx+JflMYoev5\\nLauXhZGYXCEG8sBLa2PPH9WlpgcCAwEAAaOByzCByDAdBgNVHQ4EFgQU/Vx4Cer1\\nmY3SaijxdCsA2Jo7q84wCQYDVR0TBAIwADBCBgNVHSMEOzA5gBT9XHgJ6vWZjdJq\\nKPF0KwDYmjurzqEapBgwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb22CBQIUA6MAMB0G\\nA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjA5BgNVHREEMjAwggtleGFtcGxl\\nLmNvbYIQbWFpbC5leGFtcGxlLmNvbYIPd3d3LmV4YW1wbGUuY29tMA0GCSqGSIb3\\nDQEBCwUAA4IBAQCneJA732g7srfydkgG0XJ8b1RS3ffVlnG1ahCDfIpBTx2M7Oco\\n0oa4QK4fEJnyh5Zc861aNrRHecLk4KV4QmDmLJVxTKNv3QXqgPJu+zN49x9ESwRs\\nbqiaD+K6MYmlyRukxY+v8jyOhTKvZTOjuuGKhDRcNNgn/kPIjZw3v37vY4o1pUPL\\nP1YBw2Caa01HstzouaVZlw05Viwo2AHJE5u7zW+VcA4VR8WAD/2SqdyWZIo+chwd\\nr3hWlRyHephLCBhOLb1wPk3E+mOIyryXjLpGdVnWewMSEY8AGvv7IORkO5ufCz/c\\n5UlG1r1+l5AhnFQPGoREI49hXVAETVInW9Uk\\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-----\\nMIIDdzCCAl+gAwIBAgIFAhQDowAwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL\\nZXhhbXBsZS5jb20wHhcNMTkxMTExMjAzNzUzWhcNMjAxMTEwMjAzNzUzWjAWMRQw\\nEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\\nggEBAK31N5qqd4BhMRm318tt7CP3thvJ9nXv5j3Hks8bfNggAgBmWwh/iGEoyB0e\\nmKmFkomXYQejSCkFmwI5/I+H53LA1UrnWURAHaY8UCJMMeCe22E9fbmASNMhcnov\\n/AOYBl3kEWEkKVBN3dQZFsWzj+PTTui1zHl8nrr1POPLZMS+t8D3HppNoUBwBkKR\\nQ/MetqCaQ3HlgbknMi0/5DbuaV0GJNbXNX9uhnGqQFUI21sEVU4xcvtEDN88dT1d\\nx5EhLXobDV/brXgFm85QK/lZt3aWlIJLs/WJJSK+152PO3HhfoHpkx+JflMYoev5\\nLauXhZGYXCEG8sBLa2PPH9WlpgcCAwEAAaOByzCByDAdBgNVHQ4EFgQU/Vx4Cer1\\nmY3SaijxdCsA2Jo7q84wCQYDVR0TBAIwADBCBgNVHSMEOzA5gBT9XHgJ6vWZjdJq\\nKPF0KwDYmjurzqEapBgwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb22CBQIUA6MAMB0G\\nA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjA5BgNVHREEMjAwggtleGFtcGxl\\nLmNvbYIQbWFpbC5leGFtcGxlLmNvbYIPd3d3LmV4YW1wbGUuY29tMA0GCSqGSIb3\\nDQEBCwUAA4IBAQCneJA732g7srfydkgG0XJ8b1RS3ffVlnG1ahCDfIpBTx2M7Oco\\n0oa4QK4fEJnyh5Zc861aNrRHecLk4KV4QmDmLJVxTKNv3QXqgPJu+zN49x9ESwRs\\nbqiaD+K6MYmlyRukxY+v8jyOhTKvZTOjuuGKhDRcNNgn/kPIjZw3v37vY4o1pUPL\\nP1YBw2Caa01HstzouaVZlw05Viwo2AHJE5u7zW+VcA4VR8WAD/2SqdyWZIo+chwd\\nr3hWlRyHephLCBhOLb1wPk3E+mOIyryXjLpGdVnWewMSEY8AGvv7IORkO5ufCz/c\\n5UlG1r1+l5AhnFQPGoREI49hXVAETVInW9Uk\\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">"example"</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.20"</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-----\nMIIEpAIBAAKCAQEArfU3mqp3gGExGbfXy23sI/e2G8n2de/mPceSzxt82CACAGZb\nCH+IYSjIHR6YqYWSiZdhB6NIKQWbAjn8j4fncsDVSudZREAdpjxQIkwx4J7bYT19\nuYBI0yFyei/8A5gGXeQRYSQpUE3d1BkWxbOP49NO6LXMeXyeuvU848tkxL63wPce\nmk2hQHAGQpFD8x62oJpDceWBuScyLT/kNu5pXQYk1tc1f26GcapAVQjbWwRVTjFy\n+0QM3zx1PV3HkSEtehsNX9uteAWbzlAr+Vm3dpaUgkuz9YklIr7XnY87ceF+gemT\nH4l+Uxih6/ktq5eFkZhcIQbywEtrY88f1aWmBwIDAQABAoIBAD9rmDMOFPU7+d+r\nc8QZti7Cv6TP88e5h5JccTyKg/BzcudcabHmdP0fFh3vqq6bIPqCswBK2iMChSnB\npD9bx9jBTsG5KIVGbsjNUlW+u6xtngOMnIqFp4c5uXesiM9ynFecr21f9qPtT4Nl\nBjVbqojf3/PdW8eq1F/KysEtxPYpC/RI35iL0zl8EBZ5Ydn0Yb6ftr2e72mf8JDx\nN6SgQt3E7vviRSmivuURmN9KjD+grf94fiL7PDONL/ectOWrvXnD7ppmngNuae2m\n34OHraSM46QzOp/egFc0yyNQC2PKb4YxYMq7U2ijU2rM4d809HI9jG2BXmB1I2YO\no5vZK4kCgYEA2mggZsJs7L67NXryrDNm82RnoPEjoTT2zdzl92BvMYVmu2cRyi/m\n2X5HDzTlc3l8fqFERSSc/Vc/hjluaDT+vbJzNa1tFklMbb3rXW1Z6fhqadQf34jz\nAXjeUU90aCIgAcFyTVdiz12pS1ESNCeGlRFIBF5Z3nK3MV/JmUNjEBsCgYEAy+Z/\nAtRAc6YcYseVEyo0wq2NNfDStYNp7+GhcA8qp4+1pZ8dk7n9VfkSUem0WEoi7F7g\nlUVDsWr62XiFtkV3dv77CUTlXcjmReykTzvPclT9wqyj84F09FdPZ5XusiQ0GKPe\nwLUWv+NPFlarZSxvRedlwPnC3O7FrN9TAV0/WIUCgYEAwpa/N47GKXANr6ppB8+M\nTBIK2jO+QOTFd8j2Ax8iMobebt131iIzlVeSzBOe0vFMYC4ie1ARpw3TBS2qFqIQ\nzMZvK0XmyVJpC+WIC+dfkrvHY56g/zIvAALGYL9fwV+WELpfslTHLmYObZI/m8QT\nfkC1X18Ixs6CNTVYknqdij0CgYA+btZnJFyTzMIWUOxJkPvUvFVntdSe9Z0jcWAA\nMvSpl+xTyTPCPwneIETGxhuNiS3GWIrFyg6fLZWfrzKqC/03d32gafMdU12G/Z2W\nEUdEx9dnm3scHYCVLILIwfTzoPg+rzaOpSRRHyXhPip+8SslKWRTwWY0RfxLIZqF\n6WpzDQKBgQDIFver+WSw/LTHt8LvYWyWi7pOIu6Df0ff1AYYSTMzsz9UewfRlSFw\n/ASp0dR6Po84oxIYRERxbu1ZoDhQxnGb5M1i+iFsOYBIRVmbWs4k7A0kghjGqciA\nyIbJNfSVmgNTXN4VqXW1rAqYDGDgE+huGEpnD08bPfEQm9tp0Mss5w==\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">"example"</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">"root"</span>,</div></li><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">"user"</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">"metadata"</span>: <button class="collapser" aria-label="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">"fetchsslinfo"</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/cPanel-Account-Settings/operation/fetch_ssl_vhosts" data-section-id="tag/cPanel-Account-Settings/operation/fetch_ssl_vhosts" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_ssl_vhosts" id="operation/fetch_ssl_vhosts" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Settings/operation/fetch_ssl_vhosts" aria-label="tag/cPanel-Account-Settings/operation/fetch_ssl_vhosts"></a>Return server vhosts and SSL certificates<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the server&#39;s virtual hosts (vhosts) and their installed SSL certificates.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the server's virtual hosts (vhosts) and their installed SSL certificates.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/fetch_ssl_vhosts</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/fetch_ssl_vhosts</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kjlda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kjlda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kjlda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjlda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kjlda:0" aria-labelledby="tab:R4kjlda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
fetch_ssl_vhosts
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjlda:1" aria-labelledby="tab:R4kjlda: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:R4sjlda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sjlda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sjlda:0" aria-labelledby="tab:R4sjlda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"crt"</span>: <button class="collapser" aria-label="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><li><div class="hoverable "><span class="token string">"subdomain.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">"encryption_algorithm"</span>: <span class="token string">"rsaEncryption"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"example1_com_e353a_5bc13_1408033388_9a1d40aff655f98fed7206e5af466065"</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\nsubdomain.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">"e353aa25cc8ad05d3225611e4410c0270c11b2d46f88705d3d179a23102ab24ee167c1a9070b9f554e83bade1b84256e11c5a0cb2ac96b96f28e802b11c721d73fbfe61dd9839974a6fce4e17915c0fbf885056f18656041cf70db460b22cab5fd2502491e4ab9f0d2cb727480e0ebd62e83870acda31bfa2d4625efd82234f9729f351ea02fb162609c1654c11b5dec468539a3bb83073a85f78bcf577cd8b718501145cccd89d7adb0bb18c872e7303a15e2c75a6ab315c7fa099e4351a4f0ff126c2693f71d9f21d9f798b94bb689277083fea8dcc01b6af268d0ad8b7a481f8a179d07639cdf3290c93723937a767c400a8ce4b1ca19f0a7117084d5bc13"</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">"public_exponent"</span>: <span class="token string">"010001"</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>: <button class="collapser" aria-label="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></div></li></ul><span class="token punctuation">}</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\nsubdomain.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><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">"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">"ip"</span>: <span class="token string">"192.168.0.20"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"iptype"</span>: <span class="token string">"dedicated"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ipv6"</span>: <span class="token string">"2001:0db8:0:0:1:0: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><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">"user"</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">"metadata"</span>: <button class="collapser" aria-label="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">"fetch_ssl_vhosts"</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/cPanel-Account-Settings/operation/delete_ssl_vhost" data-section-id="tag/cPanel-Account-Settings/operation/delete_ssl_vhost" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_ssl_vhost" id="operation/delete_ssl_vhost" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Settings/operation/delete_ssl_vhost" aria-label="tag/cPanel-Account-Settings/operation/delete_ssl_vhost"></a>Delete SSL vhost<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deletes the SSL virtual host.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes the SSL virtual host.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=example.com</span></div><div><div html="<p>The hostname whose SSL virtual host you&#39;d like to delete.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hostname whose SSL virtual host you'd like 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/delete_ssl_vhost</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/delete_ssl_vhost</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kklda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kklda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kklda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kklda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kklda:0" aria-labelledby="tab:R4kklda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
delete_ssl_vhost <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:R4kklda:1" aria-labelledby="tab:R4kklda: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:R4sklda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sklda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sklda:0" aria-labelledby="tab:R4sklda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"Deleting the SSL host for example.com"</span>,</div></li><li><div class="hoverable "><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">"removed_vhost_data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ip_port"</span>: <button class="collapser" aria-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.0.2.0"</span>,</div></li><li><div class="hoverable "><span class="token string">"443"</span></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_ssl"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"primary_on_ip_port"</span>: <span class="token string">"example.net"</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">"vhost_entry"</span>: <span class="token string">"<VirtualHost 192.0.2.0 :443>\nServerName example.com\nServerAlias [...]\n"</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">"metadata"</span>: <button class="collapser" aria-label="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">"delete_ssl_vhost"</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/cPanel-Account-Settings/operation/enqueue_deferred_ssl_installations" data-section-id="tag/cPanel-Account-Settings/operation/enqueue_deferred_ssl_installations" class="sc-dntaoT ceciOs"><div data-section-id="operation/enqueue_deferred_ssl_installations" id="operation/enqueue_deferred_ssl_installations" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Settings/operation/enqueue_deferred_ssl_installations" aria-label="tag/cPanel-Account-Settings/operation/enqueue_deferred_ssl_installations"></a>Add SSL certificate to installation queue<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds SSL certificates to the installation queue. This allows you to
defer and batch SSL certificate installation.</p>
<p><strong>Important:</strong></p>
<p>You <strong>must</strong> enter the same quantity of <code>username</code>, <code>cab</code>, <code>crt</code>, <code>key</code>, and <code>vhost_name</code>
parameters. For example, to add three certificates to the installation queue, enter the
<code>username</code> parameter three times, then enter three <code>cab</code>, <code>crt</code>, <code>key</code>, and <code>vhost_name</code>
parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds SSL certificates to the installation queue. This allows you to
defer and batch SSL certificate installation.</p>
<p><strong>Important:</strong></p>
<p>You <strong>must</strong> enter the same quantity of <code>username</code>, <code>cab</code>, <code>crt</code>, <code>key</code>, and <code>vhost_name</code>
parameters. For example, to add three certificates to the installation queue, enter the
<code>username</code> parameter three times, then enter three <code>cab</code>, <code>crt</code>, <code>key</code>, and <code>vhost_name</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="cab" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cab</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-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">cab=cab-1=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ8V8e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE----- cab-2=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ7V7e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE----- cab-3=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE-----</span> -<!-- --> <!-- -->Enqueue multiple CA bundles.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cab=cab=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ8V8e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE----- cab=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ7V7e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE----- cab=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE-----</span> -<!-- --> <!-- -->Enqueue multiple CA bundles.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cab=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE-----</span> -<!-- --> <!-- -->Enqueue a single CA bundle.</li></ul><div><div html="<p>The Certificate Authority (CA) bundle&#39;s contents.</p>
<p><strong>Note:</strong></p>
<ul>
<li>We recommend that you enter an empty string. An empty string tells the server to
download the CA bundle automatically.</li>
<li>To add multiple certificates to the installation queue, duplicate or increment the
parameter name. For example, <code>cab-1</code>, <code>cab-2</code>, and <code>cab-3</code>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Certificate Authority (CA) bundle's contents.</p>
<p><strong>Note:</strong></p>
<ul>
<li>We recommend that you enter an empty string. An empty string tells the server to
download the CA bundle automatically.</li>
<li>To add multiple certificates to the installation queue, duplicate or increment the
parameter name. For example, <code>cab-1</code>, <code>cab-2</code>, and <code>cab-3</code>.</li>
</ul>
</div></div></div></td></tr><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></div> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">crt=crt-1=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2CFCrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE----- crt-2=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2AZArc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE----- crt-3=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE-----</span> -<!-- --> <!-- -->Enqueue the contents of multiple certificates.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">crt=crt=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2CFCrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE----- crt=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2AZArc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE----- crt=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE-----</span> -<!-- --> <!-- -->Enqueue the contents of multiple certificates.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">crt=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE-----</span> -<!-- --> <!-- -->Enqueue a single certificate's contents.</li></ul><div><div html="<p>The certificate&#39;s contents.</p>
<p><strong>Note:</strong></p>
<p> To add multiple certificates to the installation queue, duplicate or increment the
parameter name. For example, <code>crt-1</code>, <code>crt-2</code>, and <code>crt-3</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate's contents.</p>
<p><strong>Note:</strong></p>
<p> To add multiple certificates to the installation queue, duplicate or increment the
parameter name. For example, <code>crt-1</code>, <code>crt-2</code>, and <code>crt-3</code>.</p>
</div></div></div></td></tr><tr class=""><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></div> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=key-1=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3LMNmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY----- key-2=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3TUVmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY----- key-3=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3RSHmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY-----</span> -<!-- --> <!-- -->Enqueue the private key text of multiple certificates.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3LMNmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY----- key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3TUVmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY----- key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3RSHmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY-----</span> -<!-- --> <!-- -->Enqueue the private key text of multiple certificates.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3RSHmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY-----</span> -<!-- --> <!-- -->Enqueue a single certificate's private key text.</li></ul><div><div html="<p>The private key&#39;s text.</p>
<p><strong>Note:</strong></p>
<p>To add multiple certificates to the installation queue, duplicate or increment the
parameter name. For example, <code>key-1</code>, <code>key-2</code>, and <code>key-2</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The private key's text.</p>
<p><strong>Note:</strong></p>
<p>To add multiple certificates to the installation queue, duplicate or increment the
parameter name. For example, <code>key-1</code>, <code>key-2</code>, and <code>key-2</code>.</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> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">username=username-1=username1 username-2=username2 username-3=username3</span> -<!-- --> <!-- -->Enqueue multiple SSL certificate installations.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">username=username=username1 username=username2 username=username3</span> -<!-- --> <!-- -->Enqueue multiple SSL certificate installations.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">username=username</span> -<!-- --> <!-- -->Enqueue a single SSL certificate installation.</li></ul><div><div html="<p>The cPanel account username for which to enqueue the SSL certificate installations.</p>
<p><strong>Note:</strong></p>
<p>To add multiple certificates to the installation queue, duplicate or increment the
parameter name. For example, <code>username-1</code>, <code>username-2</code>, and <code>username-3</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account username for which to enqueue the SSL certificate installations.</p>
<p><strong>Note:</strong></p>
<p>To add multiple certificates to the installation queue, duplicate or increment the
parameter name. For example, <code>username-1</code>, <code>username-2</code>, and <code>username-3</code>.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="vhost_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vhost_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"> <!-- --><<!-- -->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_name=vhost_name-1=host1.example.com vhost_name-2=host2.example.com vhost_name-3=host3.example.com</span> -<!-- --> <!-- -->Install the certificate for multiple vhosts.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">vhost_name=vhost_name=host1.example.com vhost_name=host2.example.com vhost_name=host3.example.com</span> -<!-- --> <!-- -->Install the certificate for multiple vhosts.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">vhost_name=host.example.com</span> -<!-- --> <!-- -->Install the certificate for a single vhost.</li></ul><div><div html="<p>The name of the web virtual host (vhost) for which to install the certificate.</p>
<p><strong>Note:</strong></p>
<p> To add multiple certificates to the installation queue, duplicate or increment the
parameter name. For example, <code>vhost_name-1</code>, <code>vhost_name-2</code>, and <code>vhost_name-3</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the web virtual host (vhost) for which to install the certificate.</p>
<p><strong>Note:</strong></p>
<p> To add multiple certificates to the installation queue, duplicate or increment the
parameter name. For example, <code>vhost_name-1</code>, <code>vhost_name-2</code>, and <code>vhost_name-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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/enqueue_deferred_ssl_installations</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/enqueue_deferred_ssl_installations</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kllda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kllda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kllda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kllda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kllda:0" aria-labelledby="tab:R4kllda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
enqueue_deferred_ssl_installations <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">cab</span><span class="token operator">=</span><span class="token string">'-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE-----'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">crt</span><span class="token operator">=</span><span class="token string">'-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE-----'</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-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3RSHmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY-----'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">vhost_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:R4kllda:1" aria-labelledby="tab:R4kllda: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:R4sllda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sllda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sllda:0" aria-labelledby="tab:R4sllda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"enqueue_deferred_ssl_installations"</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/cPanel-Account-Settings/operation/fetch_ssl_certificates_for_fqdns" data-section-id="tag/cPanel-Account-Settings/operation/fetch_ssl_certificates_for_fqdns" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_ssl_certificates_for_fqdns" id="operation/fetch_ssl_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-Settings/operation/fetch_ssl_certificates_for_fqdns" aria-label="tag/cPanel-Account-Settings/operation/fetch_ssl_certificates_for_fqdns"></a>Return cPanel account FQDN certificate information<!-- --> </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><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=example-1.com,example-2.com,example-3.com</span> -<!-- --> <!-- -->Fetch information for multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com</span> -<!-- --> <!-- -->Fetch information for a single domain.</li></ul><div><div html="<p>A comma-separated list of domains for which to retrieve information.</p>
<p><strong>Note:</strong></p>
<p>For browser-based calls, you <strong>must</strong> URI-encode each comma (<code>%2C</code>).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of domains for which to retrieve information.</p>
<p><strong>Note:</strong></p>
<p>For browser-based calls, you <strong>must</strong> URI-encode each 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/fetch_ssl_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/fetch_ssl_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:R4kmlda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kmlda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kmlda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmlda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kmlda:0" aria-labelledby="tab:R4kmlda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
fetch_ssl_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:R4kmlda:1" aria-labelledby="tab:R4kmlda: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:R4smlda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4smlda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4smlda:0" aria-labelledby="tab:R4smlda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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-----\nMIIDYzCCAkugAwJBAgIFAamFDR8wDQYJKoZIhvcNAQELBQAwFDESMBAGA1UEAwwJ\nc2lza28udGxkMB4XDTE5MDYyNjE1MDYxNVoXDTIwMDYyNTE1MDYxNVowFDESMBAG\nA1UEAwwJc2lza28udGxkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\nq0wqPMMP8Q6RiRXe57UXExg3PeAAd00xxFRr6pMwPZtWrkcoYV0kfHEZ7nJmD6Bd\nUnuXrDqTb1z78CeqUFt5+ZQtjGt55CjPFaUkHbNErZm2l8bKB6sjnETZ7ee4AXx/\nmaf/jhgZ0o4SMAS5h87NOoF5yg/Y0tnuncpu/RyzeXzJLxy0Mn0WMGm2w5sXSH4l\n4oaGLorGWyDUfQPjwAwcQsVi97FZ7zElRru//jJ/tqijVLELv1AWudJkuZnJJmKW\nCvkT6YpIIB8UVwbTgnFuZ86Us2Yfe17pMatAVJV8MAbRym3Z4rmWmZr1xrTdoS+L\nSwz4kCffBY5psDRp/WRqAQIDAQABo4G7MIG4MB0GA1UdDgQWBBT22CZM+khxmDvi\nF5LbZVtqm20y8TAfBgNVHSMEGDAWgBT22CZM+khxmDviF5LbZVtqm20y8TAJBgNV\nHRMEAjAAMGsGA1UdEQRkMGKCCXNpc2tvLnRsZIIObWFpbC5zaXNrby50bGSCDXd3\ndy5zaXNrby50bGSCEXdlYm1haWwuc2lza28udGxkghBjcGFuZWwuc2lza28udGxk\nghF3ZWJkaXNrLnNpc2tvLnRsZDANBgkqhkiG9w0BAQsFAAOCAQEAWDXl/WRLHPxa\nnvziWJIcM8jkSxaaUKbRPsow1XVDj3HjpDYbKkYBLfZlmaDmeU6SnmGKFYi0wSDw\n+WkK97ja3+ONHFRlYHO2dHoQrxklrqOqyV2KB0HB6YgHCl9A2b6feC31Zly2i6jc\n3SWEpYIQHecRnELc6WKkfqm0oTJZH0h7Da4WgR10Myi3GE799g0xMO/KCxPF2mDS\n6Ukr/bez9a07zCODrf4o91PrCc7r85dZq8jt02wtGMPg+zvr3FfcVPFaPZ1Oppsx\nrUNVz5W/TqdtxZhr9J5PBpSMNiNnKq88KV1zqIJiNsk9qGJbt5mQQpK0enpKqkmr\nETgwb3sSbw==\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">1538308800</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-----\nMIIDYzCCAkugAwIBAgIFAamFDR8wDQYJKoZIhvcNAQELBQAwFDESMBAGA1UEAwwJ\nc2lza28udGxkMB4XDTE5MDYyNjE1MDYxNVoXDTIwMDYyNTE1MDYxNVowFDESMBAG\nA1UEAwwJc2lza28udGxkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\nq0wqPMMP8Q6RiRXe57UXExg3PeAAd00xxFRr6pMwPZtWrkcoYV0kfHEZ7nJmD6Bd\nUnuXrDqTb1z78CeqUFt5+ZQtjGt55CjPFaUkHbNErZm2l8bKB6sjnETZ7ee4AXx/\nmaf/jhgZ0o4SMAS5h87NOoF5yg/Y0tnuncpu/RyzeXzJLxy0Mn0WMGm2w5sXSH4l\n4oaGLorGWyDUfQPjwAwcQsVi97FZ7zElRru//jJ/tqijVLELv1AWudJkuZnJJmKW\nCvkT6YpIIB8UVwbTgnFuZ86Us2Yfe17pMatAVJV8MAbRym3Z4rmWmZr1xrTdoS+L\nSwz4kCffBY5psDRp/WRqAQIDAQABo4G7MIG4MB0GA1UdDgQWBBT22CZM+khxmDvi\nF5LbZVtqm20y8TAfBgNVHSMEGDAWgBT22CZM+khxmDviF5LbZVtqm20y8TAJBgNV\nHRMEAjAAMGsGA1UdEQRkMGKCCXNpc2tvLnRsZIIObWFpbC5zaXNrby50bGSCDXd3\ndy5zaXNrby50bGSCEXdlYm1haWwuc2lza28udGxkghBjcGFuZWwuc2lza28udGxk\nghF3ZWJkaXNrLnNpc2tvLnRsZDANBgkqhkiG9w0BAQsFAAOCAQEAWDXl/WRLHPxa\nnvziWJIcM8jkSxaaUKbRPsow1XVDj3HjpDYbKkYBLfZlmaDmeU6SnmGKFYi0wSDw\n+WkK97ja3+ONHFRlYHO2dHoQrxklrqOqyV2KB0HB6YgHCl9A2b6feC31Zly2i6jc\n3SWEpYIQHecRnELc6WKkfqm0oTJZH0h7Da4WgR10Myi3GE799g0xMO/KCxPF2mDS\n6Ukr/bez9a07zCODrf4o91PrCc7r85dZq8jt02wtGMPg+zvr3FfcVPFaPZ1Oppsx\nrUNVz5W/TqdtxZhr9J5PBpSMNiNnKq88KV1zqIJiNsk9qGJbt5mQQpK0enpKqkmr\nETgwb3sSbw==\n-----END CERTIFICATE-----"</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">"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_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">0</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">"key"</span>: <span class="token string">"-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAq0wqPMMP8Q6RiRXe57UXExg3PeAAd00xxFRr6pMwPZtWrkco\nYV0kfHEZ7nJmD6BdUnuXrDqTb1z78CeqUFt5+ZQtjGt55CjPFaUkHbNErZm2l8bK\nB6sjnETZ7ee4AXx/maf/jhgZ0o4SMAS5h87NOoF5yg/Y0tnuncpu/RyzeXzJLxy0\nMn0WMGm2w5sXSH4l4oaGLorGWyDUfQPjwAwcQsVi97FZ7zElRru//jJ/tqijVLEL\nv1AWudJkuZnJJmKWCvkT6YpIIB8UVwbTgnFuZ86Us2Yfe17pMatAVJV8MAbRym3Z\n4rmWmZr1xrTdoS+LSwz4kCffBY5psDRp/WRqAQIDAQABAoIBABR96A+cxitwMrjT\nhPbzEu+V1gXw5h1ffrSd5MsLEJpOGvB+UrZTDipU3WVJCiyUYpWbc2mHGFwaI4l3\nNUinqM/SiiBiOxKwTxWny8pBx9V8rfs6LLD+KCRpmCh9r+V9n0Yics/s0in+FO7p\nocg9VQ/KrWcevjF7ILB/pwdgh5fgw3lFf1Dp3eRG2LLh+ZuY+Q2pYkMrJhSQ0H/f\nTpuYLtZ+6tGzDvnorDJZ4H6kj+7J4UXIXWSxQe0m+hkPe/YU9e9zt4vaiHSu21PC\nNKxnmBASgnLP/0lKPGzTNhc7G4HkssfqYJ1l2W+mH2sFiQKee45EQkyhcFInDzwu\ng47CIoECgYEA3/OPyAEb4WJ1NIC+1tUunUZLC18FDwO2EqoJ2adblRkG2q8DzUPg\npzQpMEo07dwVXedN7TBehl8cN1sfBfmHdznCsW6zNbZ4481hucle1fXx0/05Hajj\n/A/w3NBxjPa45Zlu6Xcot/qy7mONz+xy/oubDI8BnXxJmHIywtsFhlcCgYEAw8+i\nEAhULx5B7hcmCBruuox6stNDleoAAxuaexylvQS5Q9Kse4cEA/ti7PF5b8kDmIH4\nb6JRenaiFmFNJTbAmwQY5iaobulpEA948H6uI7A2Al3NVJacLSmTod58I5ERsDhn\nJoBAtjZuVCZjAOalnyPC4gyFcPY4O7dJwmQDa2cCgYEAsxj6ZG2WmWF+7/UCKZal\nR7ueakKcLgy+wCBh7kFr+UnhdGPAe5iMAcuyIN9Hgu2d3NINPOGQxo8rZo2lusZ6\ncnur2u/3u73o4e0u+UA0apHcyrbYxYJ6iOtKqZy9IolxBpT04RqdYrzH+eN91sl2\nkWCeJ6X6GbL6vEKfm7tCqNMCgYALyW7e+jFfGLotQ9V1PXHLZvNn2lHCL3DKvxmg\neYv8gdFJJOBfGzSBrNs6mhqOQRJnVsOGrMWs0oFVSYwkRlR3wFpjWEZhTsmVPukv\nyOBgo5XMtKrMgbhq+4q4frUISw4+hlanOacrkME5bYoeHsQvfS6Y/tn1f8zIw3K8\nMdsG1wKBgQCFPy/bzPSVV9PI+IVAlOYlbtfTCAQGQ3jG44e1b5wkwm6Di0p44kr4\n5wi4Bxy+NuCDEIksTuo2/ZtjFlrBu233mQImqZp6b5uTeB27vwAxiX55pqsU4gme\neFdttHhA6s5/wOx9E3JRFI1ucerieUROQC+bt6NLvSu7V+amdgn7bw==\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">"ab4c2a3cc30ff10e918915dee7b5171318373de000774d31c4546bea93303d9b56ae4728615d247c7119ee72660fa05d527b97ac3a936f5cfbf027aa505b79f9942d8c6b79e428cf15a5241db344ad99b697c6ca07ab239c44d9ede7b8017c7f99a7ff8e1819d28e123004b987cecd3a8179ca0fd8d2d9ee9dca6efd1cb3797cc92f1cb4327d163069b6c39b17487e25e286862e8ac65b20d47d03e3c00c1c42c562f7b159ef312546bbbffe327fb6a8a354b10bbf5016b9d264b999c92662960af913e98a48201f145706d382716e67ce94b3661f7b5ee931ab4054957c3006d1ca6dd9e2b996999af5c6b4dda12f8b4b0cf89027df058e69b03469fd646a01"</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">"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">"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></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">"command"</span>: <span class="token string">"fetch_ssl_certificates_for_fqdns"</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/cPanel-Account-Settings/operation/fetch_vhost_ssl_components" data-section-id="tag/cPanel-Account-Settings/operation/fetch_vhost_ssl_components" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_vhost_ssl_components" id="operation/fetch_vhost_ssl_components" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Settings/operation/fetch_vhost_ssl_components" aria-label="tag/cPanel-Account-Settings/operation/fetch_vhost_ssl_components"></a>Return all SSL certificate components on vhost<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the components of each SSL certificate on the server&#39;s virtual hosts.</p>
<p><strong>Warning:</strong></p>
<ul>
<li><p>On most servers, this function returns a large amount of output. We <strong>strongly</strong>
recommend that you <a href="https://go.cpanel.net/WHMAPI1FilterOutput">filter</a> and
<a href="https://go.cpanel.net/WHMAPI1SortOutput">sort</a> the output.</p>
</li>
<li><p>The following example uses the filter and sort options:</p>
<p><code>https://hostname.example.com:2087/cpsess##########/json-api/fetch_vhost_ssl_components?api.version=1&amp;api.filter.a.field=servername&amp;api.filter.a.arg0=servername.com&amp;api.filter.a.type=eq&amp;api.filter.enable=1&amp;api.sort.enable=1&amp;api.sort.a.field=servername</code></p>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the components of each SSL certificate on the server's virtual hosts.</p>
<p><strong>Warning:</strong></p>
<ul>
<li><p>On most servers, this function returns a large amount of output. We <strong>strongly</strong>
recommend that you <a href="https://go.cpanel.net/WHMAPI1FilterOutput">filter</a> and
<a href="https://go.cpanel.net/WHMAPI1SortOutput">sort</a> the output.</p>
</li>
<li><p>The following example uses the filter and sort options:</p>
<p><code>https://hostname.example.com:2087/cpsess##########/json-api/fetch_vhost_ssl_components?api.version=1&api.filter.a.field=servername&api.filter.a.arg0=servername.com&api.filter.a.type=eq&api.filter.enable=1&api.sort.enable=1&api.sort.a.field=servername</code></p>
</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/fetch_vhost_ssl_components</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/fetch_vhost_ssl_components</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4knlda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4knlda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4knlda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knlda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4knlda:0" aria-labelledby="tab:R4knlda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
fetch_vhost_ssl_components
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knlda:1" aria-labelledby="tab:R4knlda: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:R4snlda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4snlda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4snlda:0" aria-labelledby="tab:R4snlda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"components"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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 keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cabundle_id"</span>: <span class="token keyword">null</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-----\nMIIDcTCCAlmgAwIBAgIFAc/XZhswDQYJKoZIhvcNAQELBQAwFTETMBEGA1UEAwwK\ncmVzZWxsLmNvbTAeFw0xOTEyMjMxNjEwMDNaFw0yMDEyMjIxNjEwMDNaMBUxEzAR\nBgNVBAMMCnJlc2VsbC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB\nAQDs/rUGLbn4z7PeU7jMH1LeOYGc9omIATsxFwkRJUr7khxDZd59MYm2NzwLf1X2\n7ccYqYGbqjlwwpCWTrWvS9vAmrFqAr+5xp30w3bVhKrE9K+tYfUb4MbY0N/Cu0Hf\nOiSDbo07SAoOrGMHVVaPINNs1+eQ5sRxsJYBz//tOUYEJlrQAPttiHb3sk6J13Vv\nWArtk5+Q7L4lLKSxtPjQmwy/1hU2SRr0tmVkIaH77iOOMWvwB2pIYsRYjKujp0eE\ngo7FdhUIBCJ7+ZqabZHGGpm/UQ+jveI83qqB/xHD4ZxAX7GKUyHGzp8XyIPTFLNq\nAaGWN8Kv80+DZk2my78vFcjfAgMBAAGjgccwgcQwHQYDVR0OBBYEFHIsjBLssrvL\n+K0pebUQE3HYyIxFMAkGA1UdEwQCMAAwQQYDVR0jBDowOIAUciyMEuyyu8v4rSl5\ntRATcdjIjEWhGaQXMBUxEzARBgNVBAMMCnJlc2VsbC5jb22CBQHP12YbMB0GA1Ud\nJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjA2BgNVHREELzAtggpyZXNlbGwuY29t\ngg9tYWlsLnJlc2VsbC5jb22CDnd3dy5yZXNlbGwuY29tMA0GCSqGSIb3DQEBCwUA\nA4IBAQAP6DKtvvr5SQGqxPTaYraq3PU6AWJGSJwFEI4LiUauyNnXMrox4a5Mi3Bl\nOoxEoyW9Br9S6HQ7Ta0kLppcPl6RTuvJljady5feMiCSYaz59XYB5Bo8vTl7Qn7u\nq2UsLqo9qroCpF+qdmbsqR8kFUltjycnVZ8g21Hu2QoeyOKEbuzohy5mtffchoV8\nzsifokwid0f+Zd88oYPQNNPib2P9Ef06DUHy2hBBe0Wunh2McjYckRTdYgIPVANj\n0DhtCcD76Q1VtmjkReirj4CY63/8wcQ2wk37qtUI5x2SzMIAuv49HAwD7atwQKgZ\n03hIrdHhFSIwTJMG1nqyO+h3X5En\n-----END CERTIFICATE-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"certificate_id"</span>: <span class="token string">"example_com_ecfeb_5c8df_1608653403_1de5d524f287f7ec75531239a2f4a133"</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-----\nMIIEpgIBAAKCAQEA7P61Bi25+M+z3lO4zB9S3jmBnPaJiAE7MRcJESVK+5IcQ2Xe\nfTGJtjc8C39V9u3HGKmBm6o5cMKQlk61r0vbwJqxagK/ucad9MN21YSqxPSvrWH1\nG+DG2NDfwrtB3zokg26NO0gKDqxjB1VWjyDTbNfnkObEcbCWAc//7TlGBCZa0AD7\nbYh297JOidd1b1gK7ZOfkOy+JSyksbT40JsMv9YVNkka9LZlZCGh++4jjjFr8Adq\nSGLEWIyro6dHhIKOxXYVCAQie/mamm2RxhqZv1EPo73iPN6qgf8Rw+GcQF+xilMh\nxs6fF8iD0xSzagGhljfCr/NPg2ZNpsu/LxXI3wIDAQABAoIBAQDEBRA5YgzWDQVa\nuKi6vJXQFIRuDURH56zLt5/aPJw+Y+VYoaNarWSYACt73wB9UsJAVcNLu4nzCBqL\nF+MScI38Sna/ljJ6OBth3WImzKpqaW/82m7fdhVCM9E/wZ6EQhT9WK0cAUPASzlF\nUYJcs+vrtNBle1m0JziLmzy1O4/70R4Iongi6pnMbsXopA9zypKvkhQoxAEtb1i7\nJOsFKh0EDuo4tJWkbLaKmoe8CKPr+I9lRonR6q5mwwealhuvtKvPdrz1ckYwizBn\nJIAkY5s7OXbrBe4qYd/FboNem7ExuTqGWiO7oYs/RpdOGWst3Dq7l1oC/ePxbHWK\njcL5DG6hAoGBAPdQOFPQfLrI/UOTNOnghJ4xdfEPpElMOEtWZY02Oz4cZremXfhi\n+ZLOuww6f/Qey9uKH34Umi9ugszTFREEyukJJQ+nG04GkC6EmDgNcwn4lCR6iOMN\nJc8fsnRO3zZmFC9deEbfKkUWWYaVzzBEzqZpS0+DFbPrqz/NoS0WeBtJAoGBAPVR\ntN9Q8LyTA+HjT0h3tAtyLsxPlI8GAb3t89YjSkVNAAMCrUjbOx9g2cLdSIRdoKhj\n6cwRFB2OATne5E1PfyWiw5LLgUf7aGqhDhe4xOHQyN3NhBs1p1W+XNuCJJnLxnpF\nd3NnF8VUkrphlftBzYGCbtFfgzq0W6GxcSiksdrnAoGBAJEAltYFgmwdlei98aNC\nwV7jDwy0qBVVvBfn4wjFiDyleFArGiOdHElILoE/92+RcuMYe9h3ieNPfx9Kj6p3\nzeSOOQ2RY7/+tyCfG4SZ1h49gdZVhdbiCY4EPqRU7ii99w3CVtfu1qDFNt5jDaR2\nY1dMmxxWdi4UekahcOO3rdoJAoGBAMrIAGf8QxLNv47QU/AGKsivWOm/+oADKhty\nf3WJ9FG2pYTXiJ/JwGRerYJ7Yf8wWaX3+QGbOHJ5uJ+6lCMnzGUy1tEX8USsF5LU\nkI6hR/WVnQRjZokLX8frtFwqhtCudeEKXQQCus5960+vbMeljBc61xmxBwvWnEvb\nHjvHb9EPAoGBAMXpIOZPONaOZFpAnxkHMMpE8BSyCCBOYi22JiECcXQusWiI8PIT\nyxRAxIGZ6PY6ks3AEQhb9/oWSd9RVuXsflx01SFkpRIbSNwVWhLqr9HvfmpsZw2S\n5TTdqv/VaEByFDKJSIKnKk4e6rxa2XF6YxUEvZ59Bw3iP2fpksBG/nTu\n-----END RSA PRIVATE KEY-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token string">"ecfeb_5c8df_35927dbac0386ff253c269a9cda4c6f3"</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></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">"command"</span>: <span class="token string">"fetch_vhost_ssl_components"</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/cPanel-Account-Settings/operation/get_autossl_problems_for_domain" data-section-id="tag/cPanel-Account-Settings/operation/get_autossl_problems_for_domain" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_autossl_problems_for_domain" id="operation/get_autossl_problems_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-Settings/operation/get_autossl_problems_for_domain" aria-label="tag/cPanel-Account-Settings/operation/get_autossl_problems_for_domain"></a>Return domain DCV issues<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a list of objects that contains the latest Domain Control Validation (DCV) problems for a specific domain.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of objects that contains the latest Domain Control Validation (DCV) problems for a specific 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 for which to poll the DCV status.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to poll the DCV 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_autossl_problems_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_autossl_problems_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:R4kolda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kolda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kolda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kolda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kolda:0" aria-labelledby="tab:R4kolda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_autossl_problems_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:R4kolda:1" aria-labelledby="tab:R4kolda: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:R4solda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4solda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4solda:0" aria-labelledby="tab:R4solda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"problems_by_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 "><button class="collapser" aria-label="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.tld"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log"</span>: <span class="token string">"2017-08-19T13:41:04.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"problem"</span>: <span class="token string">"The domain does not resolve to any IPv4 addresses on the internet."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"time"</span>: <span class="token string">"2017-08-19T13:41:04.000Z"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_autossl_problems_for_domain"</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/cPanel-Account-Settings/operation/get_autossl_problems_for_user" data-section-id="tag/cPanel-Account-Settings/operation/get_autossl_problems_for_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_autossl_problems_for_user" id="operation/get_autossl_problems_for_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Settings/operation/get_autossl_problems_for_user" aria-label="tag/cPanel-Account-Settings/operation/get_autossl_problems_for_user"></a>Return account DCV issues<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the list of the latest Domain Control Validation (DCV) problems for a cPanel user.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the list of the latest Domain Control Validation (DCV) problems for a cPanel 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="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=username</span></div><div><div html="<p>The user for whom to poll the DCV status.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user for whom to poll the DCV 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_autossl_problems_for_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_autossl_problems_for_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:R4kplda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kplda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kplda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kplda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kplda:0" aria-labelledby="tab:R4kplda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_autossl_problems_for_user <span class="token punctuation">\</span>
<span class="token assign-left variable">username</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:R4kplda:1" aria-labelledby="tab:R4kplda: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:R4splda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4splda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4splda:0" aria-labelledby="tab:R4splda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"problems_by_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 "><button class="collapser" aria-label="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">"doesnotexist.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log"</span>: <span class="token string">"2017-09-07T03:51:01.000Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"problem"</span>: <span class="token string">"doesnotexist.example.com does not resolve to any IPv4 addresses on the internet."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"time"</span>: <span class="token string">"2017-08-12T21:02:56.000Z"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_autossl_problems_for_user"</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/cPanel-Account-Settings/operation/get_best_ssldomain_for_service" data-section-id="tag/cPanel-Account-Settings/operation/get_best_ssldomain_for_service" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_best_ssldomain_for_service" id="operation/get_best_ssldomain_for_service" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Settings/operation/get_best_ssldomain_for_service" aria-label="tag/cPanel-Account-Settings/operation/get_best_ssldomain_for_service"></a>Return SSL-encrypted domain for service access<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the most appropriate SSL-encrypted domain to use to access a service.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the most appropriate SSL-encrypted domain to use to access 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="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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service=whostmgr</span></div><div><div html="<p>The service&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_best_ssldomain_for_service</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_best_ssldomain_for_service</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kqlda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kqlda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kqlda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqlda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kqlda:0" aria-labelledby="tab:R4kqlda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_best_ssldomain_for_service <span class="token punctuation">\</span>
<span class="token assign-left variable">service</span><span class="token operator">=</span><span class="token string">'whostmgr'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqlda:1" aria-labelledby="tab:R4kqlda: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:R4sqlda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sqlda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sqlda:0" aria-labelledby="tab:R4sqlda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"none"</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">1457452989</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">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">"metadata"</span>: <button class="collapser" aria-label="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">"get_best_ssldomain_for_service"</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/cPanel-Account-Settings/operation/install_service_ssl_certificate" data-section-id="tag/cPanel-Account-Settings/operation/install_service_ssl_certificate" class="sc-dntaoT ceciOs"><div data-section-id="operation/install_service_ssl_certificate" id="operation/install_service_ssl_certificate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Settings/operation/install_service_ssl_certificate" aria-label="tag/cPanel-Account-Settings/operation/install_service_ssl_certificate"></a>Install SSL certificate for service<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function installs a new SSL certificate on a service.</p>
<p><strong>Important:</strong></p>
<p>You <strong>must</strong> restart the selected service after you install a new SSL certificate.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function installs a new SSL certificate on a service.</p>
<p><strong>Important:</strong></p>
<p>You <strong>must</strong> restart the selected service after you install a new SSL 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="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"> <!-- -->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">cabundle=-----BEGIN CERTIFICATE-----
MIIE3f4g5h7j73f235gy54hvcNAQELBQAwgYYxEDAOBgNVBAcMB2hvd097342boi0w389w0BCQEWEmMubGFycnl8293rhqurpg9qfgm5ldDEOMAwGA1UECAwFdGV4YXMxCzAJBgNVBAYTAlVTMSEwHwYDVQQDDBhiaW5hcnlhZ2Fpbi5jcGFuZWwubmluamExDzANBgNVBAoMBmNwYW5lbDAeFw0yMDA1MTgxODQ3NTFaFw0yMTA1MTgxODQ3NTFaMIGGMRAwDgYDVQQHDAdob3VzdG9uMSEwHwYJKoZIhvcNAQkBFhJjLmxhcnJ5QGNwYW5lbC5uZXQxDjAMBgNVBAgMBXRleGFzMQswCQYDVQQGEwJVUzEhMB8GA1UEAwwYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMQ8wDQYDVQQKDAZjcGFuZWwwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3i1fOlIUoURJf4BkMgoVvCeq5GZjzuCl6WXzz5WsADYUl84UzgXJIWtwBoTc2l32zyeWkIAkM/eNR12YMb0kXbgihbZtEsH0XimqcXmtiicoM3tjBi6u0cDEFr8TMdI396oArnnTc0CASfdXUGGtReZ6vOwxXOPPK5nYCvyFqBl1n0pQ2AV/Co9/WwhOCvV/Bm9aTzueZrbYB/9uW31LOpjs+0s1QNGHv6PTvH8HZFW/7Z9M3gSwUxfOOOQHEiiHRWfb/UqcTZZxjZhfY/IN6/SOsc3Z2t2KmQ5XI6ijCrjjJeaZSQYsge8LpHskr8G3WeTV9M9+1YnI7GRqs3+GdAgMBAAGjggEsMIIBKDAdBgNVHQ4EFgQUYWWThQj2tRL5PNkdPhUJdqEIcrswCQYDVR0TBAIwADCBtwYDVR0jBIGvMIGsgBRhZZOFCPa1Evk82R0+FQl2oQhyu6GBjKSBiTCBhjEQMA4GA1UEBwwHaG91c3RvbjEhMB8GCSqGSIb3DQEJARYSYy5sYXJyeUBjcGFuZWwubmV0MQ4wDAYDVQQIDAV0ZXhhczELMAkGA1UEBhMCVVMxITAfBgNVBAMMGGJpbmFyeWFnYWluLmNwYW5lbC5uaW5qYTEPMA0GA1UECgwGY3BhbmVsggUCGG94JTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwIwYDVR0RBBwwGoIYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMA0GCSqGSIb3DQEBCwUAA4IBAQBhKmds+XDTycHc2bsSH+zDkWIw58+J26Re9Q9VnUcrSKtV3mmtW88r8FuEHEZdAOzFPTJ3Tdd1fha15wuS5dzOV+bCRrDTvJmD4vRPkQ5TSdyJgpIjpjwiOP1+ZwaF7xZ+FLMTcEl8SXM+lkoKEUQpHFKyQ0zGIaLCVt0QyXx16lesPMgPeb/KRXJPy7ZrUtyF0z0LgvOSDGNsGt4rD8FVgtdHRlMJf/XIoFeV5Zk+rHNoCXIQXh4nBzM8X2r3IrQ1Qh0Z3njN2Ld8ZUlxsWctlLzvzmjARzIzvbglO3wod5XoRLS+fU6oVyQ9yuQLGG6r6Y7iBYSHfAO8e0pLkp7G
-----END CERTIFICATE-----</span></div><div><div html="<p>The certificate&#39;s Certificate Authority (CA) bundle.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> URI-encode this value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate's Certificate Authority (CA) bundle.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> URI-encode this value.</p>
</div></div></div></td></tr><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-----
MIIE3f4g5h7j73f235gy54hvcNAQELBQAwgYYxEDAOBgNVBAcMB2hvd097342boi0w389w0BCQEWEmMubGFycnl8293rhqurpg9qfgm5ldDEOMAwGA1UECAwFdGV4YXMxCzAJBgNVBAYTAlVTMSEwHwYDVQQDDBhiaW5hcnlhZ2Fpbi5jcGFuZWwubmluamExDzANBgNVBAoMBmNwYW5lbDAeFw0yMDA1MTgxODQ3NTFaFw0yMTA1MTgxODQ3NTFaMIGGMRAwDgYDVQQHDAdob3VzdG9uMSEwHwYJKoZIhvcNAQkBFhJjLmxhcnJ5QGNwYW5lbC5uZXQxDjAMBgNVBAgMBXRleGFzMQswCQYDVQQGEwJVUzEhMB8GA1UEAwwYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMQ8wDQYDVQQKDAZjcGFuZWwwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3i1fOlIUoURJf4BkMgoVvCeq5GZjzuCl6WXzz5WsADYUl84UzgXJIWtwBoTc2l32zyeWkIAkM/eNR12YMb0kXbgihbZtEsH0XimqcXmtiicoM3tjBi6u0cDEFr8TMdI396oArnnTc0CASfdXUGGtReZ6vOwxXOPPK5nYCvyFqBl1n0pQ2AV/Co9/WwhOCvV/Bm9aTzueZrbYB/9uW31LOpjs+0s1QNGHv6PTvH8HZFW/7Z9M3gSwUxfOOOQHEiiHRWfb/UqcTZZxjZhfY/IN6/SOsc3Z2t2KmQ5XI6ijCrjjJeaZSQYsge8LpHskr8G3WeTV9M9+1YnI7GRqs3+GdAgMBAAGjggEsMIIBKDAdBgNVHQ4EFgQUYWWThQj2tRL5PNkdPhUJdqEIcrswCQYDVR0TBAIwADCBtwYDVR0jBIGvMIGsgBRhZZOFCPa1Evk82R0+FQl2oQhyu6GBjKSBiTCBhjEQMA4GA1UEBwwHaG91c3RvbjEhMB8GCSqGSIb3DQEJARYSYy5sYXJyeUBjcGFuZWwubmV0MQ4wDAYDVQQIDAV0ZXhhczELMAkGA1UEBhMCVVMxITAfBgNVBAMMGGJpbmFyeWFnYWluLmNwYW5lbC5uaW5qYTEPMA0GA1UECgwGY3BhbmVsggUCGG94JTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwIwYDVR0RBBwwGoIYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMA0GCSqGSIb3DQEBCwUAA4IBAQBhKmds+XDTycHc2bsSH+zDkWIw58+J26Re9Q9VnUcrSKtV3mmtW88r8FuEHEZdAOzFPTJ3Tdd1fha15wuS5dzOV+bCRrDTvJmD4vRPkQ5TSdyJgpIjpjwiOP1+ZwaF7xZ+FLMTcEl8SXM+lkoKEUQpHFKyQ0zGIaLCVt0QyXx16lesPMgPeb/KRXJPy7ZrUtyF0z0LgvOSDGNsGt4rD8FVgtdHRlMJf/XIoFeV5Zk+rHNoCXIQXh4nBzM8X2r3IrQ1Qh0Z3njN2Ld8ZUlxsWctlLzvzmjARzIzvbglO3wod5XoRLS+fU6oVyQ9yuQLGG6r6Y7iBYSHfAO8e0pLkp7G
-----END CERTIFICATE-----</span></div><div><div html="<p>The certificate to install.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> URI-encode this value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate to install.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> URI-encode this value.</p>
</div></div></div></td></tr><tr class=""><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-----
MIIEpQIBAAKCAQEA4FIdZcIKVK5+PtdzVm4CN45BXG5wX7KZ1/dP84MGIwtwxkkX
hBqw7BawbHlexYXuarSnrHA8hm6RRxv/fRy+zOeg7y8v5CWG52m91GK7qSLxpruY
gCJGJEK8fj6spbbLjxNd5XAmDwT80uMsq/3E9rGmg/ELY9X9vn5WlErRfi2Qjsiq
x7AYUvcIkBHPOlRWzZgx2KjMjBU2U0w2RCUjgKgww/6xx2ccnTvn7HGvVjQMkh+1
UYCdGvT8fR2qJBKHZ5Cjdfc9N304qZCqYMhcrHX2gJqc+9zLtLk7PoEYXu17l6nU
O3C/IdzBXYWu+UoMzpZ5tc5jKRA3+I7ggKjJlwIDAQABAoIBAQDR4GI648qQolXh
6+iws+qFGibTGU0wbET+SBjYx/0E6t5P1vEWm3Zu3WehhgkCm6WO1omOj9BBIs/w
DSUEZNGrmwf64VZYijfm6gs+3EWiINyhWCF9uRORN5NuNquHvDhGHCOc2EnzgYIe
uYgBP0R6X4phJjS26u8mvMO6qSnKd4wRrOf9ZU73L1VTmhMItshVxH2tuhKurkMV
jWDAjWeJfycWe4JVgYxM4GA6g5kKi5nrkhpVEsklh1FJZn65U0aWXUpHAm2ihhKf
Fq9FgC+8Xz8UAtf8JYbAW3D1E/0lRZuLt+5cosK8b2+9CIUNRjYMtyXlbI0RGwl9
FO/9sv05AoGBAP0jfp8qUqf4u4pkE1W2SzzbQ6oYKYHTMiORVHi2qysgrxAZFKGj
fW7c7UTpxlCaqqDBRQA+lZH16xVD3idwYvmw/9AKxSozxe3wKbQFRM+XYHc7la+2
TiQiJgjflEadSa57FNgBB7SpeEzaIfmGBYWJXkM+6wuaGUz5qZs/SFJNAoGBAOLb
Ouh7CWTk5oISVBfqxnwFEpaMHT5vpzNBwUWUVMhrxNZP3OVSN++qKxpJhCF/M2no
OdxX7CYkrGvHFTvV9WKpa0kYQGms+ybyoMOYxJax8rV+Zq9gg2QKwaakoJljaAlX
5yUuy32YhLxWodQhE7mlhAUyXIuNLVuYee0Y2ZVzAoGAaV6tBnQHlAPljOW7ZqJL
Dzn2IIeOP4w6ArQsBVOETJ9+P6UxAVecjtlHqrfk5Qh8ng3VOxTSDb/f6yok/yW5
DVawJVlWWQrUCQc/VMActIy+iuMym8G3JTNRwb/PaNVwJkD1nDRRkNI6UUM7gTJY
eg2EP1mhXWL3xSLnhsgAwsECgYEAqnm2xfeXsqM0+bAOU77RE2e4dTuryjybeDBE
riXupIIf9DElvYrQkCDfrSxrx8RP/ZlOyd+kjXFnxMJhmYqKkW7hOZeo6ADe54DT
AMmvidMFog/v2ID9m9NdfP4f1cTW7JaLE+0bbDGOJf4wNDn7GbphAIq88v3PhRKL
JXpUIDMCgYEA2P7D/oZu+dEPW8JhUsDDXY238ZDbQzWBi6n1uUnMJCnUABd/mvuV
ILR/iSBHmt9UdH2YECwry58xFjhXwfTvPc155PiJddjENGFUqohjl0wh0VzLEyfF
Vb6iVMIdrycD/O4U26I3Qco2lQYPoPgrBkAGJ5/GCjkTiL0JssoMXa4=
-----END RSA PRIVATE KEY-----</span></div><div><div html="<p>The certificate&#39;s key.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> URI-encode this value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate's key.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> URI-encode this value.</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">"ftp"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"exim"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"dovecot"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpanel"</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 on which to install the SSL certificate.</p>
<ul>
<li><code>ftp</code></li>
<li><code>exim</code></li>
<li><code>dovecot</code></li>
<li><code>cpanel</code></li>
</ul>
<p><strong>Important:</strong></p>
<p>You <strong>must</strong> restart the selected service after you install a new SSL certificate.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service on which to install the SSL certificate.</p>
<ul>
<li><code>ftp</code></li>
<li><code>exim</code></li>
<li><code>dovecot</code></li>
<li><code>cpanel</code></li>
</ul>
<p><strong>Important:</strong></p>
<p>You <strong>must</strong> restart the selected service after you install a new SSL certificate.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/install_service_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/install_service_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:R4krlda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4krlda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4krlda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4krlda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4krlda:0" aria-labelledby="tab:R4krlda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
install_service_ssl_certificate <span class="token punctuation">\</span>
<span class="token assign-left variable">service</span><span class="token operator">=</span><span class="token string">'cpanel'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">crt</span><span class="token operator">=</span><span class="token string">'-----BEGIN CERTIFICATE-----
MIIE3f4g5h7j73f235gy54hvcNAQELBQAwgYYxEDAOBgNVBAcMB2hvd097342boi0w389w0BCQEWEmMubGFycnl8293rhqurpg9qfgm5ldDEOMAwGA1UECAwFdGV4YXMxCzAJBgNVBAYTAlVTMSEwHwYDVQQDDBhiaW5hcnlhZ2Fpbi5jcGFuZWwubmluamExDzANBgNVBAoMBmNwYW5lbDAeFw0yMDA1MTgxODQ3NTFaFw0yMTA1MTgxODQ3NTFaMIGGMRAwDgYDVQQHDAdob3VzdG9uMSEwHwYJKoZIhvcNAQkBFhJjLmxhcnJ5QGNwYW5lbC5uZXQxDjAMBgNVBAgMBXRleGFzMQswCQYDVQQGEwJVUzEhMB8GA1UEAwwYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMQ8wDQYDVQQKDAZjcGFuZWwwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3i1fOlIUoURJf4BkMgoVvCeq5GZjzuCl6WXzz5WsADYUl84UzgXJIWtwBoTc2l32zyeWkIAkM/eNR12YMb0kXbgihbZtEsH0XimqcXmtiicoM3tjBi6u0cDEFr8TMdI396oArnnTc0CASfdXUGGtReZ6vOwxXOPPK5nYCvyFqBl1n0pQ2AV/Co9/WwhOCvV/Bm9aTzueZrbYB/9uW31LOpjs+0s1QNGHv6PTvH8HZFW/7Z9M3gSwUxfOOOQHEiiHRWfb/UqcTZZxjZhfY/IN6/SOsc3Z2t2KmQ5XI6ijCrjjJeaZSQYsge8LpHskr8G3WeTV9M9+1YnI7GRqs3+GdAgMBAAGjggEsMIIBKDAdBgNVHQ4EFgQUYWWThQj2tRL5PNkdPhUJdqEIcrswCQYDVR0TBAIwADCBtwYDVR0jBIGvMIGsgBRhZZOFCPa1Evk82R0+FQl2oQhyu6GBjKSBiTCBhjEQMA4GA1UEBwwHaG91c3RvbjEhMB8GCSqGSIb3DQEJARYSYy5sYXJyeUBjcGFuZWwubmV0MQ4wDAYDVQQIDAV0ZXhhczELMAkGA1UEBhMCVVMxITAfBgNVBAMMGGJpbmFyeWFnYWluLmNwYW5lbC5uaW5qYTEPMA0GA1UECgwGY3BhbmVsggUCGG94JTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwIwYDVR0RBBwwGoIYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMA0GCSqGSIb3DQEBCwUAA4IBAQBhKmds+XDTycHc2bsSH+zDkWIw58+J26Re9Q9VnUcrSKtV3mmtW88r8FuEHEZdAOzFPTJ3Tdd1fha15wuS5dzOV+bCRrDTvJmD4vRPkQ5TSdyJgpIjpjwiOP1+ZwaF7xZ+FLMTcEl8SXM+lkoKEUQpHFKyQ0zGIaLCVt0QyXx16lesPMgPeb/KRXJPy7ZrUtyF0z0LgvOSDGNsGt4rD8FVgtdHRlMJf/XIoFeV5Zk+rHNoCXIQXh4nBzM8X2r3IrQ1Qh0Z3njN2Ld8ZUlxsWctlLzvzmjARzIzvbglO3wod5XoRLS+fU6oVyQ9yuQLGG6r6Y7iBYSHfAO8e0pLkp7G
-----END CERTIFICATE-----'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">key</span><span class="token operator">=</span><span class="token string">'-----BEGIN RSA PRIVATE KEY-----
MIIEpQIBAAKCAQEA4FIdZcIKVK5+PtdzVm4CN45BXG5wX7KZ1/dP84MGIwtwxkkX
hBqw7BawbHlexYXuarSnrHA8hm6RRxv/fRy+zOeg7y8v5CWG52m91GK7qSLxpruY
gCJGJEK8fj6spbbLjxNd5XAmDwT80uMsq/3E9rGmg/ELY9X9vn5WlErRfi2Qjsiq
x7AYUvcIkBHPOlRWzZgx2KjMjBU2U0w2RCUjgKgww/6xx2ccnTvn7HGvVjQMkh+1
UYCdGvT8fR2qJBKHZ5Cjdfc9N304qZCqYMhcrHX2gJqc+9zLtLk7PoEYXu17l6nU
O3C/IdzBXYWu+UoMzpZ5tc5jKRA3+I7ggKjJlwIDAQABAoIBAQDR4GI648qQolXh
6+iws+qFGibTGU0wbET+SBjYx/0E6t5P1vEWm3Zu3WehhgkCm6WO1omOj9BBIs/w
DSUEZNGrmwf64VZYijfm6gs+3EWiINyhWCF9uRORN5NuNquHvDhGHCOc2EnzgYIe
uYgBP0R6X4phJjS26u8mvMO6qSnKd4wRrOf9ZU73L1VTmhMItshVxH2tuhKurkMV
jWDAjWeJfycWe4JVgYxM4GA6g5kKi5nrkhpVEsklh1FJZn65U0aWXUpHAm2ihhKf
Fq9FgC+8Xz8UAtf8JYbAW3D1E/0lRZuLt+5cosK8b2+9CIUNRjYMtyXlbI0RGwl9
FO/9sv05AoGBAP0jfp8qUqf4u4pkE1W2SzzbQ6oYKYHTMiORVHi2qysgrxAZFKGj
fW7c7UTpxlCaqqDBRQA+lZH16xVD3idwYvmw/9AKxSozxe3wKbQFRM+XYHc7la+2
TiQiJgjflEadSa57FNgBB7SpeEzaIfmGBYWJXkM+6wuaGUz5qZs/SFJNAoGBAOLb
Ouh7CWTk5oISVBfqxnwFEpaMHT5vpzNBwUWUVMhrxNZP3OVSN++qKxpJhCF/M2no
OdxX7CYkrGvHFTvV9WKpa0kYQGms+ybyoMOYxJax8rV+Zq9gg2QKwaakoJljaAlX
5yUuy32YhLxWodQhE7mlhAUyXIuNLVuYee0Y2ZVzAoGAaV6tBnQHlAPljOW7ZqJL
Dzn2IIeOP4w6ArQsBVOETJ9+P6UxAVecjtlHqrfk5Qh8ng3VOxTSDb/f6yok/yW5
DVawJVlWWQrUCQc/VMActIy+iuMym8G3JTNRwb/PaNVwJkD1nDRRkNI6UUM7gTJY
eg2EP1mhXWL3xSLnhsgAwsECgYEAqnm2xfeXsqM0+bAOU77RE2e4dTuryjybeDBE
riXupIIf9DElvYrQkCDfrSxrx8RP/ZlOyd+kjXFnxMJhmYqKkW7hOZeo6ADe54DT
AMmvidMFog/v2ID9m9NdfP4f1cTW7JaLE+0bbDGOJf4wNDn7GbphAIq88v3PhRKL
JXpUIDMCgYEA2P7D/oZu+dEPW8JhUsDDXY238ZDbQzWBi6n1uUnMJCnUABd/mvuV
ILR/iSBHmt9UdH2YECwry58xFjhXwfTvPc155PiJddjENGFUqohjl0wh0VzLEyfF
Vb6iVMIdrycD/O4U26I3Qco2lQYPoPgrBkAGJ5/GCjkTiL0JssoMXa4=
-----END RSA PRIVATE KEY-----'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4krlda:1" aria-labelledby="tab:R4krlda: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:R4srlda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4srlda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4srlda:0" aria-labelledby="tab:R4srlda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <span class="token string">"-----BEGIN CERTIFICATE-----\nMIIE3f4g5h7j73f235gy54hvcNAQELBQAwgYYxEDAOBgNVBAcM\nB2hvd097342boi0w389w0BCQEWEmMubGFycnl8293rhqurpg9qfgm5ldDEOMAwG\nA1UECAwFdGV4YXMxCzAJBgNVBAYTAlVTMSEwHwYDVQQDDBhiaW5hcnlhZ2Fpbi5j\ncGFuZWwubmluamExDzANBgNVBAoMBmNwYW5lbDAeFw0yMDA1MTgxODQ3NTFaFw0y\nMTA1MTgxODQ3NTFaMIGGMRAwDgYDVQQHDAdob3VzdG9uMSEwHwYJKoZIhvcNAQkB\nFhJjLmxhcnJ5QGNwYW5lbC5uZXQxDjAMBgNVBAgMBXRleGFzMQswCQYDVQQGEwJV\nUzEhMB8GA1UEAwwYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMQ8wDQYDVQQKDAZj\ncGFuZWwwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3i1fOlIUoURJf\n4BkMgoVvCeq5GZjzuCl6WXzz5WsADYUl84UzgXJIWtwBoTc2l32zyeWkIAkM/eNR\n12YMb0kXbgihbZtEsH0XimqcXmtiicoM3tjBi6u0cDEFr8TMdI396oArnnTc0CAS\nfdXUGGtReZ6vOwxXOPPK5nYCvyFqBl1n0pQ2AV/Co9/WwhOCvV/Bm9aTzueZrbYB\n/9uW31LOpjs+0s1QNGHv6PTvH8HZFW/7Z9M3gSwUxfOOOQHEiiHRWfb/UqcTZZxj\nZhfY/IN6/SOsc3Z2t2KmQ5XI6ijCrjjJeaZSQYsge8LpHskr8G3WeTV9M9+1YnI7\nGRqs3+GdAgMBAAGjggEsMIIBKDAdBgNVHQ4EFgQUYWWThQj2tRL5PNkdPhUJdqEI\ncrswCQYDVR0TBAIwADCBtwYDVR0jBIGvMIGsgBRhZZOFCPa1Evk82R0+FQl2oQhy\nu6GBjKSBiTCBhjEQMA4GA1UEBwwHaG91c3RvbjEhMB8GCSqGSIb3DQEJARYSYy5s\nYXJyeUBjcGFuZWwubmV0MQ4wDAYDVQQIDAV0ZXhhczELMAkGA1UEBhMCVVMxITAf\nBgNVBAMMGGJpbmFyeWFnYWluLmNwYW5lbC5uaW5qYTEPMA0GA1UECgwGY3BhbmVs\nggUCGG94JTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwIwYDVR0RBBww\nGoIYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMA0GCSqGSIb3DQEBCwUAA4IBAQBh\nKmds+XDTycHc2bsSH+zDkWIw58+J26Re9Q9VnUcrSKtV3mmtW88r8FuEHEZdAOzF\nPTJ3Tdd1fha15wuS5dzOV+bCRrDTvJmD4vRPkQ5TSdyJgpIjpjwiOP1+ZwaF7xZ+\nFLMTcEl8SXM+lkoKEUQpHFKyQ0zGIaLCVt0QyXx16lesPMgPeb/KRXJPy7ZrUtyF\n0z0LgvOSDGNsGt4rD8FVgtdHRlMJf/XIoFeV5Zk+rHNoCXIQXh4nBzM8X2r3IrQ1\nQh0Z3njN2Ld8ZUlxsWctlLzvzmjARzIzvbglO3wod5XoRLS+fU6oVyQ9yuQLGG6r\n6Y7iBYSHfAO8e0pLkp7G\n-----END CERTIFICATE-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"certificate_info"</span>: <button class="collapser" aria-label="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">"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">"localityName\ncity\nemailaddress\nc.example@example.com\nstateOrProvinceName\nstate\ncountryName\nUS\ncommonName\nhostname\norganizationName\ncpanel"</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">1601467200</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">"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">"service"</span>: <span class="token string">"cpanel"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service_description"</span>: <span class="token string">"Calendar, cPanel, WebDisk, Webmail, and WHM Services"</span></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">"command"</span>: <span class="token string">"install_service_ssl_certificate"</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/cPanel-Account-Settings/operation/installssl" data-section-id="tag/cPanel-Account-Settings/operation/installssl" class="sc-dntaoT ceciOs"><div data-section-id="operation/installssl" id="operation/installssl" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Settings/operation/installssl" aria-label="tag/cPanel-Account-Settings/operation/installssl"></a>Install SSL certificate<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function installs an SSL certificate.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function installs an SSL 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="cab" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cab</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cab=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE-----</span></div><div><div html="<p>The certificate&#39;s certificate authority (CA) bundle.</p>
<p>If you do not use this parameter, the system automatically determines the
appropriate CA bundle file to use.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> URI-encode this value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate's certificate authority (CA) bundle.</p>
<p>If you do not use this parameter, the system automatically determines the
appropriate CA bundle file to use.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> URI-encode this value.</p>
</div></div></div></td></tr><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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">crt=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE-----</span></div><div><div html="<p>The certificate&#39;s text.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> URI-encode this value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate's text.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> URI-encode this 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&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain's name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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">ip=192.168.0.20</span></div><div><div html="<p>The IP address of the certificate&#39;s domain.</p>
<p>This parameter defaults to the domain&#39;s local IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IP address of the certificate's domain.</p>
<p>This parameter defaults to the domain's local IP address.</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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr/eJ5GRmIATYsJIepKbrDy70sq+udcO8R8xxak0oMZ/9mUdpjSNK/fLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC/nf/OEZLm3ZbnBgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ++q62bFV89jkHWTMcKyyqHENo3hc+lkpd9vnp8rZTinaVb7nX26uQqAFZYRo+WU0G/NPsq40QVSMoqPxyEz4qXo0hvuIlCXmzFZq/6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2+QXSNiA1AwWr8l0r4rtzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoCt1WJFxQgD4goE0U6k+Kt7vjbOt14Pk6v/B2yjaju1wSGpO59WLS4/XrwI2se6IXrmba7u3VUEgWXLriNHoLy7/SMNTs+ZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCsIwpU+azosk0oylWLEX/m/uHWEs1eaIEWWWtgHB+KZrrP7Rr9RYfVQ144DxmOxS3Ca9+mST62WqAVPR6POWGEfZqnZl/ePWZPcQYbFrhwnnefNoYBl/bnLZBo8rbNWxAqOEOuKfkrBzglKG/39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol/3FvwDa3uJpkpmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7/ezWe9yn+bMpjSIWfsgtq4FsyqzPueEkDdQWi3xh6nu2WI/1Tl875opGAqEIJMqss/u11tnva5wzu1cCL6H85A5+HMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1ptXBmXLC/YKKvtHI3M16/ZopvM8ZqU2HcAHaw214Refw9JJ/e3/xTNfSerVTyCAQO1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW/ZfLrc1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj+75psgbAr6ELGgItJ9yPBLVRr+cUzEpx9LDWVvjMihpP4NX1gq8EOPWT+ewLHVmmsjCyV6xw8JXXF8e2xif3in0m3D/wCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6dv1Q4EF1+fbK3YCW+VpCBsB9NAoGAQo+uhNLODee56iKkzpjXWCsFTq6ar3hD5F3P63buKdNwhd2GlSPhXFbf+7M5GWW6BZk6rMvv7EOAVice2uvyFm8/4/1WbmF8R+T7LX1rPLO5p/m701QpvP11TabiwqRkqtSEQhSRF0AKTojSW/yyHCZFAawUhV/Z9EKiHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3DfrxUj6lG3z/oKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe/crbLePuBwIR0L7drXxfv7O5btY7h6QI2d1/UIAQPAWbxLoTM+ndQ/uPEdfA%3D%3D-----END%20RSA%20PRIVATE%20KEY-----</span></div><div><div html="<p>The certificate&#39;s key.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> URI-encode this value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate's key.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/installssl</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/installssl</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kslda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kslda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kslda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kslda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kslda:0" aria-labelledby="tab:R4kslda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
installssl <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">crt</span><span class="token operator">=</span><span class="token string">'-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE-----'</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-----%0AMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr/eJ5GRmIATYsJIepKbrDy70sq+udcO8R8xxak0oMZ/9mUdpjSNK/fLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC/nf/OEZLm3ZbnBgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ++q62bFV89jkHWTMcKyyqHENo3hc+lkpd9vnp8rZTinaVb7nX26uQqAFZYRo+WU0G/NPsq40QVSMoqPxyEz4qXo0hvuIlCXmzFZq/6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2+QXSNiA1AwWr8l0r4rtzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoCt1WJFxQgD4goE0U6k+Kt7vjbOt14Pk6v/B2yjaju1wSGpO59WLS4/XrwI2se6IXrmba7u3VUEgWXLriNHoLy7/SMNTs+ZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCsIwpU+azosk0oylWLEX/m/uHWEs1eaIEWWWtgHB+KZrrP7Rr9RYfVQ144DxmOxS3Ca9+mST62WqAVPR6POWGEfZqnZl/ePWZPcQYbFrhwnnefNoYBl/bnLZBo8rbNWxAqOEOuKfkrBzglKG/39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol/3FvwDa3uJpkpmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7/ezWe9yn+bMpjSIWfsgtq4FsyqzPueEkDdQWi3xh6nu2WI/1Tl875opGAqEIJMqss/u11tnva5wzu1cCL6H85A5+HMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1ptXBmXLC/YKKvtHI3M16/ZopvM8ZqU2HcAHaw214Refw9JJ/e3/xTNfSerVTyCAQO1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW/ZfLrc1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj+75psgbAr6ELGgItJ9yPBLVRr+cUzEpx9LDWVvjMihpP4NX1gq8EOPWT+ewLHVmmsjCyV6xw8JXXF8e2xif3in0m3D/wCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6dv1Q4EF1+fbK3YCW+VpCBsB9NAoGAQo+uhNLODee56iKkzpjXWCsFTq6ar3hD5F3P63buKdNwhd2GlSPhXFbf+7M5GWW6BZk6rMvv7EOAVice2uvyFm8/4/1WbmF8R+T7LX1rPLO5p/m701QpvP11TabiwqRkqtSEQhSRF0AKTojSW/yyHCZFAawUhV/Z9EKiHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3DfrxUj6lG3z/oKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe/crbLePuBwIR0L7drXxfv7O5btY7h6QI2d1/UIAQPAWbxLoTM+ndQ/uPEdfA%3D%3D-----END%20RSA%20PRIVATE%20KEY-----'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kslda:1" aria-labelledby="tab:R4kslda: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:R4sslda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sslda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sslda:0" aria-labelledby="tab:R4sslda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"install"</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 string">"mail.example.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"subdomain.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">"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">"mail.example.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"subdomain.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">"Certificate verification passed<br/> <br /> The Certificate for the domain example.com was installed on the IP 192.168.0.20. </html><br><b>Finished SSL Install Process for example.com (www.example.com).</b>"</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.20"</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.20\". Apache is restarting in the background."</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">"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">"The SSL certificate is now installed onto the domain \"example.com\" using the IP address \"192.168.0.20\". Apache 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">"username"</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">"subdomain.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">"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><li><div class="hoverable "><span class="token string">"mail.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">"metadata"</span>: <button class="collapser" aria-label="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">"installssl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <span class="token string">"<br>The SSL certificate is now installed onto the domain “example.com“ using the IP address“192.168 .0 .20“. < br / > Apache is restarting in the background."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"The SSL certificate is now installed onto the domain “example.com“ using the IP address “192.168.0.20“.Apache is restarting in the background."</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/SSL-Server-Settings" data-section-id="tag/SSL-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/SSL-Server-Settings" aria-label="tag/SSL-Server-Settings"></a>SSL Server Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>SSL Certificates / SSL Server Settings</p>
"><p>SSL Certificates / SSL Server Settings</p>
</div></div></div><div id="tag/SSL-Server-Settings/operation/fetch_service_ssl_components" data-section-id="tag/SSL-Server-Settings/operation/fetch_service_ssl_components" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_service_ssl_components" id="operation/fetch_service_ssl_components" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Server-Settings/operation/fetch_service_ssl_components" aria-label="tag/SSL-Server-Settings/operation/fetch_service_ssl_components"></a>Return system services and associated certificates<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the system&#39;s services and their associated certificates.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the system's services and their associated certificates.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/fetch_service_ssl_components</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/fetch_service_ssl_components</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9nda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9nda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9nda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9nda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9nda:0" aria-labelledby="tab:R2a9nda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
fetch_service_ssl_components
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9nda:1" aria-labelledby="tab:R2a9nda: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:R2e9nda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9nda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9nda:0" aria-labelledby="tab:R2e9nda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">""</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-----\nMIIECjCCAvKgAwIBAgIEW7p6xzANBgkqhkiG9w0BAQUFADCBnTELMAkGA1UEBhMC\nVVMxEDAOBgNVBAgMB1Vua25vd24xEDAOBgNVBAcMB1Vua25vd24xEDAOBgNVBAoM\nB1Vua25vd24xEDAOBgNVBAsMB1Vua25vd24xHTAbBgNVBAMMFGphc29uLmRldi5j\ncGFuZWwubmV0MScwJQYJKoZIhvcNAQkBFhhzc2xAamFzb24uZGV2LmNwYW5lbC5u\nZXQwHhcNMTMwNDI5MjEwNDU5WhcNMTQwNDI5MjEwNDU5WjCBnTELMAkGA1UEBhMC\nVVMxEDAOBgNVBAgMB1Vua25vd24xEDAOBgNVBAcMB1Vua25vd24xEDAOBgNVBAoM\nB1Vua25vd24xEDAOBgNVBAsMB1Vua25vd24xHTAbBgNVBAMMFGphc29uLmRldi5j\ncGFuZWwubmV0MScwJQYJKoZIhvcNAQkBFhhzc2xAamFzb24uZGV2LmNwYW5lbC5u\nZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCmc8Oxc0RmSzX4eR9W\nLTrqa/TY+qOuP8ClGTgP1FOWSjZnfDTUhnfst/XtA13wJvXw+Pv+IXReUtrx87nl\njHPwuu/bcJMg4iAufQUlCwUaWbMP8f7yLYPXFAwcgc6jFKCJDOjSImeZhyGBxYp0\nAWx6qiz/WscrV1zs3o8wSqVyouoD2LFzq3bG6M2539DageERnO/UuLTb++DkbH8e\n4v6LX9VQTljMvA0TtPpB7Mnr0Nq+HR/sXHJPdIFn58BVPpl/m3frNqvOcJc/Bt8V\nF0jUG3WN4+/Xr6byRkoVR/X/FYRp2W4ki+Rk357aDnzoVKiTMqLBJ4sXxCU2ipYE\n9FTbAgMBAAGjUDBOMB0GA1UdDgQWBBSiMwrIK+JMVx8ufKnfByp3V+ycoTAfBgNV\nHSMEGDAWgBSiMwrIK+JMVx8ufKnfByp3V+ycoTAMBgNVHRMEBTADAQH/MA0GCSqG\nSIb3DQEBBQUAA4IBAQAdL/oywZw+EMwNGf/e1JqjXull/fgoNMZHxsBwQb2smZuN\nKoTlkf2zDO7yTTIUnrBP1TveIlAejDLMMR7yqVgmDrVM/pl4WQjL/APbrWGExsE8\nJeEu+DjOIEveOVTTXCwaVo8ck2JO3QWZwPeRUZBwifZOfaYa8gwpdcUy8Tu/HX9T\nxsOLv/vQar8JC4Obh5eFrMBp87Obf1m/2Kmpaj9PGQQiiq+HU3r4dZf24bLGESr/\nvPXIfInwZ0Fr4G+OzwDqPgI9nCm13myZ+ZBybL64pp741ReRP1dHQGYnwtht/Dh4\n/vFZEL9Wv/18E4lUCJjMgBIknjWkyt6FtygmB1DS\n-----END CERTIFICATE-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"certificate_info"</span>: <button class="collapser" aria-label="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">"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">"Writer's Guild of America"</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\nUnknown\nlocalityName\nUnknown\norganizationName\nUnknown\norganizationalUnitName\nUnknown\ncommonName\nexample.com\nemailAddress\ntest@example.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 keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus_length"</span>: <span class="token keyword">null</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></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"</span>: <span class="token string">"-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEA4FIdZcIKVK5+PtdzVm4CN45BXG5wX7KZ1/dP84MGIwtwxkkX\nhBqw7BawbHlexYXuarSnrHA8hm6RRxv/fRy+zOeg7y8v5CWG52m91GK7qSLxpruY\ngCJGJEK8fj6spbbLjxNd5XAmDwT80uMsq/3E9rGmg/ELY9X9vn5WlErRfi2Qjsiq\nx7AYUvcIkBHPOlRWzZgx2KjMjBU2U0w2RCUjgKgww/6xx2ccnTvn7HGvVjQMkh+1\nUYCdGvT8fR2qJBKHZ5Cjdfc9N304qZCqYMhcrHX2gJqc+9zLtLk7PoEYXu17l6nU\nO3C/IdzBXYWu+UoMzpZ5tc5jKRA3+I7ggKjJlwIDAQABAoIBAQDR4GI648qQolXh\n6+iws+qFGibTGU0wbET+SBjYx/0E6t5P1vEWm3Zu3WehhgkCm6WO1omOj9BBIs/w\nDSUEZNGrmwf64VZYijfm6gs+3EWiINyhWCF9uRORN5NuNquHvDhGHCOc2EnzgYIe\nuYgBP0R6X4phJjS26u8mvMO6qSnKd4wRrOf9ZU73L1VTmhMItshVxH2tuhKurkMV\njWDAjWeJfycWe4JVgYxM4GA6g5kKi5nrkhpVEsklh1FJZn65U0aWXUpHAm2ihhKf\nFq9FgC+8Xz8UAtf8JYbAW3D1E/0lRZuLt+5cosK8b2+9CIUNRjYMtyXlbI0RGwl9\nFO/9sv05AoGBAP0jfp8qUqf4u4pkE1W2SzzbQ6oYKYHTMiORVHi2qysgrxAZFKGj\nfW7c7UTpxlCaqqDBRQA+lZH16xVD3idwYvmw/9AKxSozxe3wKbQFRM+XYHc7la+2\nTiQiJgjflEadSa57FNgBB7SpeEzaIfmGBYWJXkM+6wuaGUz5qZs/SFJNAoGBAOLb\nOuh7CWTk5oISVBfqxnwFEpaMHT5vpzNBwUWUVMhrxNZP3OVSN++qKxpJhCF/M2no\nOdxX7CYkrGvHFTvV9WKpa0kYQGms+ybyoMOYxJax8rV+Zq9gg2QKwaakoJljaAlX\n5yUuy32YhLxWodQhE7mlhAUyXIuNLVuYee0Y2ZVzAoGAaV6tBnQHlAPljOW7ZqJL\nDzn2IIeOP4w6ArQsBVOETJ9+P6UxAVecjtlHqrfk5Qh8ng3VOxTSDb/f6yok/yW5\nDVawJVlWWQrUCQc/VMActIy+iuMym8G3JTNRwb/PaNVwJkD1nDRRkNI6UUM7gTJY\neg2EP1mhXWL3xSLnhsgAwsECgYEAqnm2xfeXsqM0+bAOU77RE2e4dTuryjybeDBE\nriXupIIf9DElvYrQkCDfrSxrx8RP/ZlOyd+kjXFnxMJhmYqKkW7hOZeo6ADe54DT\nAMmvidMFog/v2ID9m9NdfP4f1cTW7JaLE+0bbDGOJf4wNDn7GbphAIq88v3PhRKL\nJXpUIDMCgYEA2P7D/oZu+dEPW8JhUsDDXY238ZDbQzWBi6n1uUnMJCnUABd/mvuV\nILR/iSBHmt9UdH2YECwry58xFjhXwfTvPc155PiJddjENGFUqohjl0wh0VzLEyfF\nVb6iVMIdrycD/O4U26I3Qco2lQYPoPgrBkAGJ5/GCjkTiL0JssoMXa4=\n-----END RSA PRIVATE KEY-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"ftp"</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">"metadata"</span>: <button class="collapser" aria-label="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">"fetch_service_ssl_components"</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/SSL-Server-Settings/operation/generatessl" data-section-id="tag/SSL-Server-Settings/operation/generatessl" class="sc-dntaoT ceciOs"><div data-section-id="operation/generatessl" id="operation/generatessl" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Server-Settings/operation/generatessl" aria-label="tag/SSL-Server-Settings/operation/generatessl"></a>Create self-signed SSL certificate<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function generates a private key file, a certificate signing request (CSR), and a self-signed SSL certificate.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function generates a private key file, a certificate signing request (CSR), and a self-signed SSL 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="countryName" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">countryName</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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 certificate&#39;s country code.</p>
<p>If you do not use this parameter, your CSR will <strong>not</strong> include this field.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate's country code.</p>
<p>If you do not use this parameter, your CSR will <strong>not</strong> include this field.</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=domain=example1.com,example2.com,example3.com</span> -<!-- --> <!-- -->Generate an SSL certificate for multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com</span> -<!-- --> <!-- -->Generate an SSL certificate for a single domain.</li></ul><div><div html="<p>A comma-separated list of the certificate&#39;s domains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of the certificate's domains.</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"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">emailAddress=username@example.com</span></div><div><div html="<p>The certificate&#39;s contact email address.</p>
<p>If you do not use this parameter, your CSR will <strong>not</strong> include this field.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate's contact email address.</p>
<p>If you do not use this parameter, your CSR will <strong>not</strong> include this field.</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"> <!-- -->>= 1<!-- --> </span></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 size of the certificate&#39;s key, in bits.</p>
<p>If you do not use this parameter, your CSR will <strong>not</strong> include this field.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The size of the certificate's key, in bits.</p>
<p>If you do not use this parameter, your CSR will <strong>not</strong> include this field.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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.</p>
<p>If you do not use this parameter, your CSR will <strong>not</strong> include this field.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate's city or locality.</p>
<p>If you do not use this parameter, your CSR will <strong>not</strong> include this field.</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 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">organizationalUnitName=Development</span></div><div><div html="<p>The department of the organization that owns the certificate.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The department of the organization that owns the certificate.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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=Example, L.L.C.</span></div><div><div html="<p>The certificate&#39;s organization.</p>
<p>If you do not use this parameter, your CSR will <strong>not</strong> include this field.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate's organization.</p>
<p>If you do not use this parameter, your CSR will <strong>not</strong> include this field.</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 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">pass=123456luggage</span></div><div><div html="<p>The certificate&#39;s passphrase.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate's passphrase.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="skip_certificate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skip_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">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">skip_certificate=0</span></div><div><div html="<p>Whether the function will skip certificate generation.</p>
<ul>
<li><code>1</code> — Skip certificate generate (do <strong>not</strong> generate a certificate).</li>
<li><code>0</code> — Do <strong>not</strong> skip certificate generation (generate a certificate).</li>
</ul>
<p><strong>Note:</strong></p>
<p>The function will still generate a CSR and key and save both to the user&#39;s <code>SSLStorage</code>
data store.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the function will skip certificate generation.</p>
<ul>
<li><code>1</code> — Skip certificate generate (do <strong>not</strong> generate a certificate).</li>
<li><code>0</code> — Do <strong>not</strong> skip certificate generation (generate a certificate).</li>
</ul>
<p><strong>Note:</strong></p>
<p>The function will still generate a CSR and key and save both to the user's <code>SSLStorage</code>
data store.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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 province name.</p>
<p>If you do not use this parameter, your CSR will <strong>not</strong> include this field.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate's state or province name.</p>
<p>If you do not use this parameter, your CSR will <strong>not</strong> include this 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/generatessl</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/generatessl</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aanda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aanda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aanda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aanda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aanda:0" aria-labelledby="tab:R2aanda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
generatessl <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:R2aanda:1" aria-labelledby="tab:R2aanda: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:R2eanda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eanda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eanda:0" aria-labelledby="tab:R2eanda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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-----\nMIIDVDCCAjygAwIBAgIFANMbQ1IwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL\nZXhhbXBsZS5jb20wHhcNMjAwMzE2MTg1OTU4WhcNMjEwMzE2MTg1OTU4WjAWMRQw\nEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\nggEBALnif/SIEE3xfi7iXCI3Kk7yNFrKw9b3SbCwTFEV4HZZpX+gK0ZkwT1vkkT6\nIFs68DVJI9KxXycCY8ZVI64TeD5Hqqy3p9NAkALyfC9OJlDP/mAKjgUZYISMci4K\njuf252rrtox5I5DgbWfXGe12HAjOnQrNjJMvscU9DstXMjDtzrlpwHZ/PH+v/Rcw\nt1WwpcAVOFNxQq6Z0CDwKW/JsHu7tVRa57QMlLTm2BEMIPlTHHoHRJk0zOQuHP3x\n87eYpnCiE/WbC5xlfm912fnFvvECb/6OGtAsw7GC0KnovS1W+rPfZHAdbbA61ukU\nMh+U5VJaNot/kqfbJYpkMD1VRu8CAwEAAaOBqDCBpTAdBgNVHQ4EFgQUSU78eVCc\nJPFAzdImFwAufRu+2WEwCQYDVR0TBAIwADBCBgNVHSMEOzA5gBRJTvx5UJwk8UDN\n0iYXAC59G77ZYaEapBgwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb22CBQDTG0NSMB0G\nA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAWBgNVHREEDzANggtleGFtcGxl\nLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEAf9dzrKj4LGvkBN3q0VHvPsKicl8tABxK\nuv4vKoiAXuh7R9k2bnFqpfvDa7j2qbBd5Gh4ctjdwTv7eA/E0sELgxlezcx9grgX\nCk//GRieAoEj6ZOx1AdKw/Pj6jQyMpU9mQi7+nbpcl1CmQlBc9c2OiayjAAwxm1s\n+Uj7C9+OOkFXeLt/adurcKHhDO3tVD9fqr+pFiVjJOyuIr+T/84gAUAK4RxipaDg\nf35OapjaVQesolECPEP9l/ajf5e2C33JBDwoVqa3b7wwhStN4YpF+7SAd74K1QRz\nrPum8QKnzZjwtx0OBRJl/CHQBz4u0LJGBH4vXhgzzoAcdlGouKf8RA==\n-----END CERTIFICATE-----\n"</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_a2459_9d253_1405012775_521f3620ac92180d24a74813a921b23e"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"certfile"</span>: <span class="token string">"/var/cpanel/ssl/system/certs/example_com_e0054_da789_1405012513_401c27501f5e0dd8d1b1d9caa902a0c8.crt"</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-----\nMIIChDCCAWwCAQAwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb20wggEiMA0GCSqGSIb3\nDQEBAQUAA4IBDwAwggEKAoIBAQC54n/0iBBN8X4u4lwiNypO8jRaysPW90mwsExR\nFeB2WaV/oCtGZME9b5JE+iBbOvA1SSPSsV8nAmPGVSOuE3g+R6qst6fTQJAC8nwv\nTiZQz/5gCo4FGWCEjHIuCo7n9udq67aMeSOQ4G1n1xntdhwIzp0KzYyTL7HFPQ7L\nVzIw7c65acB2fzx/r/0XMLdVsKXAFThTcUKumdAg8ClvybB7u7VUWue0DJS05tgR\nDCD5Uxx6B0SZNMzkLhz98fO3mKZwohP1mwucZX5vddn5xb7xAm/+jhrQLMOxgtCp\n6L0tVvqz32RwHW2wOtbpFDIflOVSWjaLf5Kn2yWKZDA9VUbvAgMBAAGgKTAnBgkq\nhkiG9w0BCQ4xGjAYMBYGA1UdEQQPMA2CC2V4YW1wbGUuY29tMA0GCSqGSIb3DQEB\nCwUAA4IBAQCEPc5HD2KRQpqqm7aG6Y/oOnbGALi7GcOsr/vo+voWRDhC/nTAC9vp\nDXEjWY4FfA7N1VSgH5f04k40SBWlfvgCzQAB2AfLEo6LReNv1oCpojvKZVbJq+pq\nKTEMhkFzj4CBTG2gt9rAhKmNai7AnvDWdrnulsVShAsQMYsEeVmCxfGE9w3IEmLP\nJSvUB6/RSPF8zB5yP6/tZy00k+Mt/959yPAxDicrNASbCA2/TkuaBEaP+2v9lJY7\nzg2Z1js/Nv/5DE+1sqp+7GI26M6ZCSNzSyTVs2MOl6ecJTxhRCbVTYFy9SDRtsGE\nVOpPe2+XTcBM/mGIIRJharQNgy7S8kZ0\n-----END CERTIFICATE REQUEST-----\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"csr_id"</span>: <span class="token string">"example_com_e0054_da789_96b6625681492b7c43844b6ec37764de"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"csrfile"</span>: <span class="token string">"/var/cpanel/ssl/system/csrs/example_com_a2459_9d253_d5edb563abb8dd426099bbb358c8f2bc.csr"</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-----\nMIIEowIBAAKCAQEAueJ/9IgQTfF+LuJcIjcqTvI0WsrD1vdJsLBMURXgdlmlf6Ar\nRmTBPW+SRPogWzrwNUkj0rFfJwJjxlUjrhN4PkeqrLen00CQAvJ8L04mUM/+YAqO\nBRlghIxyLgqO5/bnauu2jHkjkOBtZ9cZ7XYcCM6dCs2Mky+xxT0Oy1cyMO3OuWnA\ndn88f6/9FzC3VbClwBU4U3FCrpnQIPApb8mwe7u1VFrntAyUtObYEQwg+VMcegdE\nmTTM5C4c/fHzt5imcKIT9ZsLnGV+b3XZ+cW+8QJv/o4a0CzDsYLQqei9LVb6s99k\ncB1tsDrW6RQyH5TlUlo2i3+Sp9slimQwPVVG7wIDAQABAoIBAGIHgzdwcjjIvKT5\nF2Gr+hH8RYQEHtfFPgWCVB0HDoMbr93omCndhNNjfZ4G0v2JzZgsZEn+5JFr/zZf\nPBvXhLhDj0za5hTQnaIQQ1GnQymnJx17M36Y7X+5mZWSV98ZJN4MRQ8763fCA7CZ\njcDfYtV6MPO7hwEwS+4azyyJZZzLRUP2Z8kpXv3PFlXUeddZHwQgyKRdLcQWXE/w\niFClYSfsk10y8Nm6BKzI6TkZS32zIGt3FdJ8+kARJteV0sg6hjPpZMH0223Cbn+h\nlq9eU5b8N5xq7FBmmrfpJcaPdkmo8nUzEGQszyHHjF3N3p78065T+PEb+Jlirsl/\nQf48ssECgYEA9o5wPmAtP8/tdDtdUSHJDbvERq0i2SeEmlrc/82mw82WlHA//sg8\npqeT3EtH8QdvZqSVSw74Yr4TNOLMwLt8T5Rg+gPYsdoqc++d8hB/ru6nvRBwJ437\nZN2JeoEObvNv4QgnfFpeKGxgaX49Yx6u0DJsABWpWsAppCUTXtxP2D8CgYEAwQEo\nQ0tFhwKz4e2gSyOSkuWUJi+tbY//+ouZEGlIYCzObXsZ/bM/AIEZKiAVTdyY5h91\nnAXLFRgcP3z0+h0XeiTcSZN4oEiMwL1/mPmx4uBMZijV54+ABjUFbVStlzxh4KLN\nzf0HUOPAA1biCNDn1yY+a8C+hKky2Ec+Nx//ZVECgYBqD5v5OSY97RQYi/D4lbAH\nWF52iMQU5gsE21F2OOEkGaxM7nyY/UoZ5ryUZ03rQWeKoAIY57exwlJAzc+GmSBA\nm3OcGUt+NntMpCctmitS9RbzHb8hRNJ/8UzShfHPiKj4BKn3tGgMu5I9zzBZEzng\nFdCfuLHBeChxlAFhLSSrwQKBgQCUUsxbcvRavmP5Y8HFHPBevdotwoQ4Z+rj4/Zc\nm1yItMZrcqhVxTPMsmnhasiUjsxeRZz/q6AXdPD4hZJKyKKrNrqoPJH+M+MfmEIA\nERx468Eq3YUNsMVFf+fMzr+dM0VQ+izJegPuUSjWKCYLemhBet2Lt5NypgkyFwYk\nHQ4MEQKBgCeQOxNn2exJj0B6wt0Ts+tHdQlreLv+7zMB+CWODnkaXAiRqB8mr1O1\nmFZApPHnx3HUrxRsiHfvf9m2N2gpzyVcK86zbQSti5PB9sqEMw5eHd1qtlPSOV31\nJUG9qpLL/Jf6+AsZCNGOrjMQD99Sh3x/tPZVbK49OyOe6HxV5Ht0\n-----END RSA PRIVATE KEY-----\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token string">"e0054_da789_101721a053024156a34e0df8a9c388d4"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"keyfile"</span>: <span class="token string">"/var/cpanel/ssl/system/keys/e0054_da789_101721a053024156a34e0df8a9c388d4.key"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sender"</span>: <span class="token string">"admin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sender_host"</span>: <span class="token string">"hostname.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">"command"</span>: <span class="token string">"generatessl"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Key, Certificate, and CSR generated 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/SSL-Server-Settings/operation/listcrts" data-section-id="tag/SSL-Server-Settings/operation/listcrts" class="sc-dntaoT ceciOs"><div data-section-id="operation/listcrts" id="operation/listcrts" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Server-Settings/operation/listcrts" aria-label="tag/SSL-Server-Settings/operation/listcrts"></a>Return domains with installed SSL certificates<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the server&#39;s domains with installed SSL certificates.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the server's domains with installed SSL certificates.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="registered" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">registered</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">registered=1</span></div><div><div html="<p>Whether to limit the results to certificates registered with
a certificate authority (CA).</p>
<ul>
<li><code>1</code> — Registered certificates <strong>only</strong>.</li>
<li><code>0</code> — All certificates.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to limit the results to certificates registered with
a certificate authority (CA).</p>
<ul>
<li><code>1</code> — Registered certificates <strong>only</strong>.</li>
<li><code>0</code> — All certificates.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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=username</span></div><div><div html="<p>The cPanel username.</p>
<p>If you do <strong>not</strong> use this parameter, the function returns certificates
for <strong>all</strong> accounts on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel username.</p>
<p>If you do <strong>not</strong> use this parameter, the function returns certificates
for <strong>all</strong> accounts on the 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/listcrts</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/listcrts</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abnda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abnda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abnda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abnda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abnda:0" aria-labelledby="tab:R2abnda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
listcrts
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abnda:1" aria-labelledby="tab:R2abnda: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:R2ebnda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebnda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebnda:0" aria-labelledby="tab:R2ebnda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"crt"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"domain_owners"</span>: <button class="collapser" aria-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">"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">"friendly_name"</span>: <span class="token string">"TestCertificate"</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_d13b4_362b9_1400343187_b05e5c3e443dda9a8869c4cf7457829e"</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.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_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">"registered"</span>: <span class="token number">1</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">"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></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">"command"</span>: <span class="token string">"listcrts"</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/SSL-Server-Settings/operation/rebuilduserssldb" data-section-id="tag/SSL-Server-Settings/operation/rebuilduserssldb" class="sc-dntaoT ceciOs"><div data-section-id="operation/rebuilduserssldb" id="operation/rebuilduserssldb" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Server-Settings/operation/rebuilduserssldb" aria-label="tag/SSL-Server-Settings/operation/rebuilduserssldb"></a>Update SSL certificate users database<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function rebuilds the database of SSL certificate users.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function rebuilds the database of SSL certificate users.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/rebuilduserssldb</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/rebuilduserssldb</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acnda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acnda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acnda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acnda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acnda:0" aria-labelledby="tab:R2acnda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
rebuilduserssldb
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acnda:1" aria-labelledby="tab:R2acnda: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:R2ecnda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecnda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecnda:0" aria-labelledby="tab:R2ecnda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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 "><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">"metadata"</span>: <button class="collapser" aria-label="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">"rebuilduserssldb"</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/SSL-Server-Settings/operation/reset_service_ssl_certificate" data-section-id="tag/SSL-Server-Settings/operation/reset_service_ssl_certificate" class="sc-dntaoT ceciOs"><div data-section-id="operation/reset_service_ssl_certificate" id="operation/reset_service_ssl_certificate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Server-Settings/operation/reset_service_ssl_certificate" aria-label="tag/SSL-Server-Settings/operation/reset_service_ssl_certificate"></a>Create self-signed SSL certificate for service<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function regenerates a self-signed SSL certificate and assigns it to a service.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function regenerates a self-signed SSL certificate and assigns it to 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="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">"ftp"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"exim"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"dovecot"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cpanel"</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.</p>
<ul>
<li><code>ftp</code> - The <code>ftp</code> service.</li>
<li><code>exim</code> - The <code>exim</code> service.</li>
<li><code>dovecot</code> - The <code>dovecot</code> service.</li>
<li><code>cpanel</code> - The <code>cpanel</code> service.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service.</p>
<ul>
<li><code>ftp</code> - The <code>ftp</code> service.</li>
<li><code>exim</code> - The <code>exim</code> service.</li>
<li><code>dovecot</code> - The <code>dovecot</code> service.</li>
<li><code>cpanel</code> - The <code>cpanel</code> service.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/reset_service_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/reset_service_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:R2adnda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adnda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adnda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adnda:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adnda:0" aria-labelledby="tab:R2adnda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
reset_service_ssl_certificate <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:R2adnda:1" aria-labelledby="tab:R2adnda: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:R2ednda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ednda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ednda:0" aria-labelledby="tab:R2ednda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <span class="token string">"-----BEGIN CERTIFICATE-----\nMIIDWzCCAkOgAwIBAgIFAiil8fgwDQYJKoZIhvcNAQELBQAwRjEcMBoGA1UEAwwT\ndm01LmRvY3MuY3BhbmVsLm5ldDEmMCQGCSqGSIb3DQEJARYXc3NsQHZtNS5kb2Nz\nLmNwYW5lbC5uZXQwHhcNMTQxMTI0MTg0NDE5WhcNMTUxMTI0MTg0NDE5WjBGMRww\nGgYDVQQDDBN2bTUuZG9jcy5jcGFuZWwubmV0MSYwJAYJKoZIhvcNAQkBFhdzc2xA\ndm01LmRvY3MuY3BhbmVsLm5ldDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\nggEBAKYsBFQaqfz9ggP2uw+Vm4196hDlgZtx/A7cN7ktDkCzztxpQ1Us6zty0DPB\nKm6aMhi8tvfO1/DU8+L2ybmgXXmAvhMjEdBYtiMd7rUVAo4zuPOzwABJzfTq46Wk\ntQiuT9TZ+051ixFLRyz58ke0jAqqQugeZK1d5q1m82lUow3LU3oPhtYiR31ROU4g\nHt1/p+okMf3T21Bl6lLXQf8EVwUL8c0zrRsLYlhIFGyedaVqoZ47anGFc0U0ZJzw\nBOXnmxbYZY+pExXiNZpxTjUDKgtLvY8CjrHjNgVXSL9S7J8Src4/l7SvKoRjnAit\nKsMh6d/nTC4bukX5FGBph9anoFcCAwEAAaNQME4wHQYDVR0OBBYEFDBzN9RDgdnH\nHx5x7iUeBDX8qQ3yMB8GA1UdIwQYMBaAFDBzN9RDgdnHHx5x7iUeBDX8qQ3yMAwG\nA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBACYT6VSDfRxsGIzzoYMlIN9K\nd1pfDqFVFKZecI9M+fc0iAnYYRm5VUpItw5fAoMbrjCL4XMZKImSmkAWc4m9cCDs\nWT4rSEE/Fhv3dUjI3Hg7CFoxwU+Ke+yORsPNCv/9lDjReh9pU120UIttOa1lu9NN\nkT8QcUN0+NAvhj6MTm87VsQBNEpQhddyPuOmtga/zf8HTOcvtbeoRTueVNa4yNvP\n3UI6FLwNWNebzgm5zunahY7svqrTbKkNbQbIFqHrhSZdY5i7+I7Lgi9hfri7nDDk\nl6Dv+Ntm0LKWJNEKuZ8I+QVuJiFIFqF/8Gsqc/8pDuJF3b7UchyqGCXJhnExBR4=\n-----END CERTIFICATE-----"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"certificate_info"</span>: <button class="collapser" aria-label="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">"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">"Writer's Guild of America"</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\nhostname.example.com\nemailAddress\nssl@hostname.example.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">1398805499</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_before"</span>: <span class="token number">1367269499</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"ftp"</span></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">"command"</span>: <span class="token string">"reset_service_ssl_certificate"</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/Install-or-Uninstall-Package" data-section-id="tag/Install-or-Uninstall-Package" 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/Install-or-Uninstall-Package" aria-label="tag/Install-or-Uninstall-Package"></a>Install or Uninstall Package</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>System Package Management / Install or Uninstall Package</p>
"><p>System Package Management / Install or Uninstall Package</p>
</div></div></div><div id="tag/Install-or-Uninstall-Package/operation/package_manager_submit_actions" data-section-id="tag/Install-or-Uninstall-Package/operation/package_manager_submit_actions" class="sc-dntaoT ceciOs"><div data-section-id="operation/package_manager_submit_actions" id="operation/package_manager_submit_actions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Install-or-Uninstall-Package/operation/package_manager_submit_actions" aria-label="tag/Install-or-Uninstall-Package/operation/package_manager_submit_actions"></a>Start RPM package installation, update, or removal<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function installs, upgrades, or uninstalls RPM packages.</p>
<p><strong>Note:</strong></p>
<p>The system queues this function&#39;s actions to run as background tasks. The actions may
require additional time to finish.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function installs, upgrades, or uninstalls RPM packages.</p>
<p><strong>Note:</strong></p>
<p>The system queues this function's actions to run as background tasks. The actions may
require additional time to finish.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="install" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">install</span></td><td class="sc-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">install=install=package1 install=package2</span> -<!-- --> <!-- -->Install multiple RPM packages.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">install=package1</span> -<!-- --> <!-- -->Install a single RPM package.</li></ul><div><div html="<p>The RPM package that you want to install. If you do not use this parameter, the function
does not install a package.</p>
<p><strong>Note:</strong></p>
<p>You can pass this parameter multiple times to install more than one RPM package</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The RPM package that you want to install. If you do not use this parameter, the function
does not install a package.</p>
<p><strong>Note:</strong></p>
<p>You can pass this parameter multiple times to install more than one RPM package</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="uninstall" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">uninstall</span></td><td class="sc-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">uninstall=uninstall=package3 uninstall=package4 uninstall=package5</span> -<!-- --> <!-- -->Uninstall multiple RPM packages.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">uninstall=package3</span> -<!-- --> <!-- -->Uninstall a single RPM package.</li></ul><div><div html="<p>The RPM package that you want to uninstall. If you do not use this parameter, the function
does not uninstall a package.</p>
<p><strong>Note:</strong></p>
<p>You can pass this parameter multiple times to uninstall more than one RPM package.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The RPM package that you want to uninstall. If you do not use this parameter, the function
does not uninstall a package.</p>
<p><strong>Note:</strong></p>
<p>You can pass this parameter multiple times to uninstall more than one RPM package.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="upgrade" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">upgrade</span></td><td class="sc-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">upgrade=upgrade=package6 upgrade=package7 upgrade=package8</span> -<!-- --> <!-- -->Upgrade multiple RPM packages.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">upgrade=package6</span> -<!-- --> <!-- -->Upgrade a single RPM package.</li></ul><div><div html="<p>The RPM package that you want to upgrade. If you do not use this parameter, the function
does not upgrade a package.</p>
<p><strong>Note:</strong></p>
<p>You can pass this parameter multiple times to upgrade more than one RPM package.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The RPM package that you want to upgrade. If you do not use this parameter, the function
does not upgrade a package.</p>
<p><strong>Note:</strong></p>
<p>You can pass this parameter multiple times to upgrade more than one RPM package.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/package_manager_submit_actions</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/package_manager_submit_actions</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9jdq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9jdq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9jdq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9jdq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9jdq:0" aria-labelledby="tab:R2a9jdq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
package_manager_submit_actions
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9jdq:1" aria-labelledby="tab:R2a9jdq: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:R2e9jdq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9jdq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9jdq:0" aria-labelledby="tab:R2e9jdq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token number">9717</span></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">"command"</span>: <span class="token string">"package_manager_submit_actions"</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/Install-or-Uninstall-Package/operation/package_manager_upgrade" data-section-id="tag/Install-or-Uninstall-Package/operation/package_manager_upgrade" class="sc-dntaoT ceciOs"><div data-section-id="operation/package_manager_upgrade" id="operation/package_manager_upgrade" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Install-or-Uninstall-Package/operation/package_manager_upgrade" aria-label="tag/Install-or-Uninstall-Package/operation/package_manager_upgrade"></a>Start RPM package upgrade<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function downloads and installs package updates on the server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function downloads and installs package updates on the 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/package_manager_upgrade</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/package_manager_upgrade</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aajdq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aajdq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aajdq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aajdq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aajdq:0" aria-labelledby="tab:R2aajdq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
package_manager_upgrade
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aajdq:1" aria-labelledby="tab:R2aajdq: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:R2eajdq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eajdq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eajdq:0" aria-labelledby="tab:R2eajdq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build"</span>: <span class="token number">10111</span></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">"command"</span>: <span class="token string">"package_manager_upgrade"</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/Install-or-Uninstall-Package/operation/install_rpm_plugin" data-section-id="tag/Install-or-Uninstall-Package/operation/install_rpm_plugin" class="sc-dntaoT ceciOs"><div data-section-id="operation/install_rpm_plugin" id="operation/install_rpm_plugin" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Install-or-Uninstall-Package/operation/install_rpm_plugin" aria-label="tag/Install-or-Uninstall-Package/operation/install_rpm_plugin"></a>Install WHM plugin RPM package<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function starts a plugin installation. The installation runs as a background process.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function starts a plugin installation. The installation runs as a background process.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=plugin name</span></div><div><div html="<p>The name of a plugin RPM to install.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of a plugin RPM to install.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/install_rpm_plugin</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/install_rpm_plugin</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abjdq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abjdq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abjdq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abjdq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abjdq:0" aria-labelledby="tab:R2abjdq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
install_rpm_plugin <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'plugin name'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abjdq:1" aria-labelledby="tab:R2abjdq: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:R2ebjdq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebjdq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebjdq:0" aria-labelledby="tab:R2ebjdq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_entry"</span>: <span class="token string">"2017-01-01T19:39:27Z_plugin_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pid"</span>: <span class="token number">1234</span></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">"command"</span>: <span class="token string">"install_rpm_plugin"</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/Install-or-Uninstall-Package/operation/uninstall_rpm_plugin" data-section-id="tag/Install-or-Uninstall-Package/operation/uninstall_rpm_plugin" class="sc-dntaoT ceciOs"><div data-section-id="operation/uninstall_rpm_plugin" id="operation/uninstall_rpm_plugin" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Install-or-Uninstall-Package/operation/uninstall_rpm_plugin" aria-label="tag/Install-or-Uninstall-Package/operation/uninstall_rpm_plugin"></a>Uninstall WHM plugin RPM package<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function starts the uninstall process for a plugin. The uninstall process runs as a background process.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function starts the uninstall process for a plugin. The uninstall process runs as a background process.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></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=plugin_name</span></div><div><div html="<p>The name of a plugin RPM to uninstall.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of a plugin RPM to uninstall.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/uninstall_rpm_plugin</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/uninstall_rpm_plugin</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acjdq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acjdq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acjdq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acjdq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acjdq:0" aria-labelledby="tab:R2acjdq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
uninstall_rpm_plugin <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'plugin_name'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acjdq:1" aria-labelledby="tab:R2acjdq: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:R2ecjdq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecjdq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecjdq:0" aria-labelledby="tab:R2ecjdq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_entry"</span>: <span class="token string">"2017-01-01T19:39:27Z_plugin_name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pid"</span>: <span class="token number">1234</span></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">"command"</span>: <span class="token string">"uninstall_rpm_plugin"</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/List-Package-Information" data-section-id="tag/List-Package-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/List-Package-Information" aria-label="tag/List-Package-Information"></a>List Package Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>System Package Management / List Package Information</p>
"><p>System Package Management / List Package Information</p>
</div></div></div><div id="tag/List-Package-Information/operation/package_manager_is_performing_actions" data-section-id="tag/List-Package-Information/operation/package_manager_is_performing_actions" class="sc-dntaoT ceciOs"><div data-section-id="operation/package_manager_is_performing_actions" id="operation/package_manager_is_performing_actions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/List-Package-Information/operation/package_manager_is_performing_actions" aria-label="tag/List-Package-Information/operation/package_manager_is_performing_actions"></a>Return RPM package update status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks the activity of the process that you executed in the WHM API 1 <code>package_manager_submit_actions</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks the activity of the process that you executed in the WHM API 1 <code>package_manager_submit_actions</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="build" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">build</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">build=10053</span></div><div><div html="<p>The process&#39;s build number returned by the WHM API 1 <code>package_manager_submit_actions</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The process's build number returned by the WHM API 1 <code>package_manager_submit_actions</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/package_manager_is_performing_actions</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/package_manager_is_performing_actions</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9ldq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9ldq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9ldq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9ldq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9ldq:0" aria-labelledby="tab:R2a9ldq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
package_manager_is_performing_actions <span class="token punctuation">\</span>
<span class="token assign-left variable">build</span><span class="token operator">=</span><span class="token string">'10053'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9ldq:1" aria-labelledby="tab:R2a9ldq: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:R2e9ldq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9ldq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9ldq:0" aria-labelledby="tab:R2e9ldq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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></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">"command"</span>: <span class="token string">"package_manager_is_performing_actions"</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/List-Package-Information/operation/package_manager_list_packages" data-section-id="tag/List-Package-Information/operation/package_manager_list_packages" class="sc-dntaoT ceciOs"><div data-section-id="operation/package_manager_list_packages" id="operation/package_manager_list_packages" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/List-Package-Information/operation/package_manager_list_packages" aria-label="tag/List-Package-Information/operation/package_manager_list_packages"></a>Return available RPM packages<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists information about the system&#39;s available RPM packages.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists information about the system's available RPM packages.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"any"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"any"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"installed"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"not_installed"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"updatable"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">state=installed</span></div><div><div html="<p>Return RPM packages that exist in a specified state.</p>
<ul>
<li><code>any</code> — All RPMs available on the system.</li>
<li><code>installed</code> — The RPMs installed on the system.</li>
<li><code>not_installed</code> — The available RPMs not yet installed on the system.</li>
<li><code>updatable</code> — The RPMs with updates available.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Return RPM packages that exist in a specified state.</p>
<ul>
<li><code>any</code> — All RPMs available on the system.</li>
<li><code>installed</code> — The RPMs installed on the system.</li>
<li><code>not_installed</code> — The available RPMs not yet installed on the system.</li>
<li><code>updatable</code> — The RPMs with updates available.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><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>A list of RPM objects that match the requested <code>state</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of RPM objects that match the requested <code>state</code>.</p>
</div></div></div></td></tr><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">/package_manager_list_packages</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/package_manager_list_packages</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aaldq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aaldq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aaldq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaldq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aaldq:0" aria-labelledby="tab:R2aaldq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
package_manager_list_packages
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaldq:1" aria-labelledby="tab:R2aaldq: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:R2ealdq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ealdq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ealdq:0" aria-labelledby="tab:R2ealdq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"package"</span>: <span class="token string">"MariaDB-client"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"package"</span>: <span class="token string">"MariaDB-common"</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">"metadata"</span>: <button class="collapser" aria-label="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">"package_manager_list_packages"</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/List-Package-Information/operation/get_rpm_version_data" data-section-id="tag/List-Package-Information/operation/get_rpm_version_data" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_rpm_version_data" id="operation/get_rpm_version_data" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/List-Package-Information/operation/get_rpm_version_data" aria-label="tag/List-Package-Information/operation/get_rpm_version_data"></a>Return available RPM packages<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists a key&#39;s available RPMs. For more information, read our
<a href="https://go.cpanel.net/rpm-versions">rpm.versions system</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a key's available RPMs. For more information, read our
<a href="https://go.cpanel.net/rpm-versions">rpm.versions system</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="key" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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=3rdparty</span></div><div><div html="<p>The RPM&#39;s key. If you do <strong>not</strong> specify a value, the function returns all RPM categories.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The RPM's key. If you do <strong>not</strong> specify a value, the function returns all RPM categories.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="section" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">section</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">section=rpm_groups</span></div><div><div html="<p>The RPM&#39;s section.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The RPM's section.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object or object</span></div> <div><div html="<p>The RPM section and its associated RPMs.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function uses the RPM section&#39;s name and RPM key&#39;s name for each return value.</li>
<li>If you specify the <code>key</code> parameter, this function returns <strong>only</strong> the called RPM key.</li>
<li>If you do <strong>not</strong> specify the <code>key</code> parameter, the function returns <strong>all</strong> RPM keys
in the called <code>section</code> parameter.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The RPM section and its associated RPMs.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function uses the RPM section's name and RPM key's name for each return value.</li>
<li>If you specify the <code>key</code> parameter, this function returns <strong>only</strong> the called RPM key.</li>
<li>If you do <strong>not</strong> specify the <code>key</code> parameter, the function returns <strong>all</strong> RPM keys
in the called <code>section</code> parameter.</li>
</ul>
</div></div></div></td></tr><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">/get_rpm_version_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_rpm_version_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:R2abldq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abldq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abldq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abldq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abldq:0" aria-labelledby="tab:R2abldq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_rpm_version_data <span class="token punctuation">\</span>
<span class="token assign-left variable">section</span><span class="token operator">=</span><span class="token string">'rpm_groups'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abldq:1" aria-labelledby="tab:R2abldq: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:R2ebldq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebldq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebldq:0" aria-labelledby="tab:R2ebldq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"3rdparty"</span>: <button class="collapser" aria-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-pcre"</span>,</div></li><li><div class="hoverable "><span class="token string">"cpanel-pixman"</span>,</div></li><li><div class="hoverable "><span class="token string">"cpanel-analog"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"get_rpm_version_data"</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/List-Package-Information/operation/list_rpms" data-section-id="tag/List-Package-Information/operation/list_rpms" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_rpms" id="operation/list_rpms" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/List-Package-Information/operation/list_rpms" aria-label="tag/List-Package-Information/operation/list_rpms"></a>Return required but uninstalled server RPM package<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists RPMs that the server needs, but the server owner has not yet installed.
When you call this function, it performs the same actions as the following command:</p>
<p><code>/usr/local/cpanel/scripts/check_cpanel_pkgs --list-only --targets[target]</code></p>
<p>For more information, read our
<a href="https://docs.cpanel.net/knowledge-base/rpm-versions/introduction-to-the-rpm-versions-system/">rpm.versions system</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists RPMs that the server needs, but the server owner has not yet installed.
When you call this function, it performs the same actions as the following command:</p>
<p><code>/usr/local/cpanel/scripts/check_cpanel_pkgs --list-only --targets[target]</code></p>
<p>For more information, read our
<a href="https://docs.cpanel.net/knowledge-base/rpm-versions/introduction-to-the-rpm-versions-system/">rpm.versions system</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="target" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">target</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">target=3rdparty</span></div><div><div html="<p>The target that depends on the uninstalled RPMs. If you do not specify a value, the function lists all of the required but uninstalled RPMs for all RPM targets.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The target that depends on the uninstalled RPMs. If you do not specify a value, the function lists all of the required but uninstalled RPMs for all RPM targets.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/list_rpms</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/list_rpms</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acldq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acldq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acldq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acldq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acldq:0" aria-labelledby="tab:R2acldq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
list_rpms
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acldq:1" aria-labelledby="tab:R2acldq: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:R2ecldq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecldq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecldq:0" aria-labelledby="tab:R2ecldq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"rpms"</span>: <button class="collapser" aria-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-pcre"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"list_rpms"</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/List-Package-Information/operation/package_manager_get_package_info" data-section-id="tag/List-Package-Information/operation/package_manager_get_package_info" class="sc-dntaoT ceciOs"><div data-section-id="operation/package_manager_get_package_info" id="operation/package_manager_get_package_info" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/List-Package-Information/operation/package_manager_get_package_info" aria-label="tag/List-Package-Information/operation/package_manager_get_package_info"></a>Return available RPM packages information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves information about the system&#39;s available
RPM packages.</p>
<p><strong>Note:</strong></p>
<p>You must use <strong>either</strong> the <code>ns</code> or the <code>package</code> parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves information about the system's available
RPM packages.</p>
<p><strong>Note:</strong></p>
<p>You must use <strong>either</strong> the <code>ns</code> or the <code>package</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="disable-excludes" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">disable-excludes</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">disable-excludes=1</span></div><div><div html="<p>Whether the system will disable <a href="https://en.wikipedia.org/wiki/Yum_(software)">yum</a>&#39;s
exclude behavior.</p>
<ul>
<li><code>1</code> — Disable yum&#39;s exclude behavior.</li>
<li><code>0</code> — Do <strong>not</strong> disable yum&#39;s exclude behavior.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the system will disable <a href="https://en.wikipedia.org/wiki/Yum_(software)">yum</a>'s
exclude behavior.</p>
<ul>
<li><code>1</code> — Disable yum's exclude behavior.</li>
<li><code>0</code> — Do <strong>not</strong> disable yum's exclude behavior.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="ns" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ns</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"ea"</span> </div> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ns=ns=ea ns=altea</span> -<!-- --> <!-- -->View multiple namespaces.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ns=ea</span> -<!-- --> <!-- -->View one namespace.</li></ul><div><div html="<p>An available RPM package namespace.</p>
<p><strong>Note:</strong></p>
<ul>
<li><code>ea</code> and any from <code>ea4_get_additional_pkg_prefixes</code> API call are the <strong>only</strong> possible values.</li>
<li>If you use this parameter, you cannot use the <code>package</code> parameter.</li>
<li>To view more than one namespace, pass the parameter multiple times. For example,
<code>ns=ea</code> and <code>ns=altea</code>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An available RPM package namespace.</p>
<p><strong>Note:</strong></p>
<ul>
<li><code>ea</code> and any from <code>ea4_get_additional_pkg_prefixes</code> API call are the <strong>only</strong> possible values.</li>
<li>If you use this parameter, you cannot use the <code>package</code> parameter.</li>
<li>To view more than one namespace, pass the parameter multiple times. For example,
<code>ns=ea</code> and <code>ns=altea</code>.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="package" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">package</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-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">package=package=ea-php55 package=ea-apr-util</span> -<!-- --> <!-- -->View multiple packages.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">package=ea-php55</span> -<!-- --> <!-- -->View one package.</li></ul><div><div html="<p>An RPM package name on the system.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you use this parameter, you cannot use the <code>ns</code> parameter.</li>
<li>To view more than one package, pass the parameter multiple times. For example,
<code>package=ea-php55</code> and <code>package=ea-apr-util</code>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An RPM package name on the system.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you use this parameter, you cannot use the <code>ns</code> parameter.</li>
<li>To view more than one package, pass the parameter multiple times. For example,
<code>package=ea-php55</code> and <code>package=ea-apr-util</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/package_manager_get_package_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/package_manager_get_package_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:R2adldq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adldq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adldq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adldq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adldq:0" aria-labelledby="tab:R2adldq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
package_manager_get_package_info <span class="token punctuation">\</span>
<span class="token assign-left variable">ns</span><span class="token operator">=</span><span class="token string">'ea'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">package</span><span class="token operator">=</span><span class="token string">'ea-php55'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adldq:1" aria-labelledby="tab:R2adldq: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:R2edldq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edldq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edldq:0" aria-labelledby="tab:R2edldq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"architecture"</span>: <span class="token string">"x86_64"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"license"</span>: <span class="token string">"ASL 2.0"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"long_description"</span>: <span class="token string">"The mission of the Apache Portable Runtime (APR) is to provide a\\nfree library of C data structures and routines."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"more_info_url"</span>: <span class="token string">"</span><a href="http://apr.apache.org">http://apr.apache.org</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"package"</span>: <span class="token string">"ea-apr-util"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pkg_dep"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"conflicts"</span>: <button class="collapser" aria-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-php55-php-ioncube5"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requires"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"glibc"</span>,</div></li><li><div class="hoverable "><span class="token string">"libuuid"</span>,</div></li><li><div class="hoverable "><span class="token string">"expat"</span>,</div></li><li><div class="hoverable "><span class="token string">"libdb"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-apr"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pkg_group"</span>: <span class="token string">"System Environment/Libraries"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"release"</span>: <span class="token string">"7.7.1.cpanel"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repo_name"</span>: <span class="token string">"NYI"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"short_description"</span>: <span class="token string">"Apache Portable Runtime Utility library"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">214647</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">"updatable"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"1.6.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version_installed"</span>: <span class="token string">"1.6.1-4.4.8.cpanel"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version_latest"</span>: <span class="token string">"1.6.1-7.7.1.cpanel"</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">"metadata"</span>: <button class="collapser" aria-label="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">"package_manager_get_package_info"</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/List-Package-Information/operation/package_manager_resolve_actions" data-section-id="tag/List-Package-Information/operation/package_manager_resolve_actions" class="sc-dntaoT ceciOs"><div data-section-id="operation/package_manager_resolve_actions" id="operation/package_manager_resolve_actions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/List-Package-Information/operation/package_manager_resolve_actions" aria-label="tag/List-Package-Information/operation/package_manager_resolve_actions"></a>Return possible RPM package changes<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function determines the actions that would result from the provisioning of a specified RPM package or packages.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function determines the actions that would result from the provisioning of a specified RPM package or packages.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="ns" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ns</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"ea"</span> </div> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ns=ns=ea ns=altea</span> -<!-- --> <!-- -->Operate under multiple namespaces.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ns=ea</span> -<!-- --> <!-- -->Operate under one namespace.</li></ul><div><div html="<p>The RPM namespace that represents a set of packages.
<strong>Note:</strong></p>
<ul>
<li><code>ea</code> and any from <code>ea4_get_additional_pkg_prefixes</code> API call are the <strong>only</strong> possible values. * When more than one namespace is involved, pass the parameter multiple times. For example, <code>ns=ea</code> and <code>ns=altea</code>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The RPM namespace that represents a set of packages.
<strong>Note:</strong></p>
<ul>
<li><code>ea</code> and any from <code>ea4_get_additional_pkg_prefixes</code> API call are the <strong>only</strong> possible values. * When more than one namespace is involved, pass the parameter multiple times. For example, <code>ns=ea</code> and <code>ns=altea</code>.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="package" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">package</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-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">package=package=ea-apache24-mod_headers package=ea-apache24-mod_cgid package=ea-apache24-mod_mpm_event</span> -<!-- --> <!-- -->Submit multiple RPM packages.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">package=ea-apache24-mod_headers</span> -<!-- --> <!-- -->Submit a single RPM package.</li></ul><div><div html="<p>The name of an RPM package.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To submit more than one package, pass the parameter multiple times. For example,
<code>package=ea-php55</code> and <code>package=ea-apr-util</code>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of an RPM package.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To submit more than one package, pass the parameter multiple times. For example,
<code>package=ea-php55</code> and <code>package=ea-apr-util</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/package_manager_resolve_actions</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/package_manager_resolve_actions</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aeldq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aeldq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aeldq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aeldq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aeldq:0" aria-labelledby="tab:R2aeldq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
package_manager_resolve_actions <span class="token punctuation">\</span>
<span class="token assign-left variable">package</span><span class="token operator">=</span><span class="token string">'ea-apache24-mod_headers'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aeldq:1" aria-labelledby="tab:R2aeldq: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:R2eeldq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eeldq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eeldq:0" aria-labelledby="tab:R2eeldq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"install"</span>: <button class="collapser" aria-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_mpm_event"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-apache24-mod_cgid"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"unaffected"</span>: <button class="collapser" aria-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-php70-php-devel"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php56-runtime"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php55-php-common"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-apache24-mod_headers"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php56-php-bcmath"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php70-php-curl"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php70-php-xml"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uninstall"</span>: <button class="collapser" aria-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_cgi"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-apache24-mod_mpm_prefork"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"upgrade"</span>: <button class="collapser" aria-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-php56"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"package_manager_resolve_actions"</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/Package-Manager-Settings" data-section-id="tag/Package-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/Package-Manager-Settings" aria-label="tag/Package-Manager-Settings"></a>Package Manager Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>System Package Management / Package Manager Settings</p>
"><p>System Package Management / Package Manager Settings</p>
</div></div></div><div id="tag/Package-Manager-Settings/operation/package_manager_get_build_log" data-section-id="tag/Package-Manager-Settings/operation/package_manager_get_build_log" class="sc-dntaoT ceciOs"><div data-section-id="operation/package_manager_get_build_log" id="operation/package_manager_get_build_log" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Package-Manager-Settings/operation/package_manager_get_build_log" aria-label="tag/Package-Manager-Settings/operation/package_manager_get_build_log"></a>Return RPM management build log<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns build log content.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns build log content.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="build" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">build</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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">build=1234</span></div><div><div html="<p>The build process ID returned by the <code>package_manager_submit_actions</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The build process ID returned by the <code>package_manager_submit_actions</code> function.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="offset" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">offset</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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"> <!-- --><<!-- -->bytes<!-- -->><!-- --> </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">offset=4567</span></div><div><div html="<p>The position in the build log from which you wish to display entries.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The position in the build log from which you wish to display entries.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/package_manager_get_build_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/package_manager_get_build_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:R2a9ndq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9ndq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9ndq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9ndq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9ndq:0" aria-labelledby="tab:R2a9ndq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
package_manager_get_build_log <span class="token punctuation">\</span>
<span class="token assign-left variable">build</span><span class="token operator">=</span><span class="token string">'1234'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">offset</span><span class="token operator">=</span><span class="token string">'4567'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9ndq:1" aria-labelledby="tab:R2a9ndq: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:R2e9ndq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9ndq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9ndq:0" aria-labelledby="tab:R2e9ndq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"line1"</span>,</div></li><li><div class="hoverable "><span class="token string">"line2"</span>,</div></li><li><div class="hoverable "><span class="token string">"line3"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"offset"</span>: <span class="token number">9672</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"still_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">"metadata"</span>: <button class="collapser" aria-label="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">"package_manager_get_build_log"</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/Package-Manager-Settings/operation/package_manager_fixcache" data-section-id="tag/Package-Manager-Settings/operation/package_manager_fixcache" class="sc-dntaoT ceciOs"><div data-section-id="operation/package_manager_fixcache" id="operation/package_manager_fixcache" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Package-Manager-Settings/operation/package_manager_fixcache" aria-label="tag/Package-Manager-Settings/operation/package_manager_fixcache"></a>Repair RPM management yum cache issues<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function attempts to repair yum cache issues.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function attempts to repair yum cache issues.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/package_manager_fixcache</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/package_manager_fixcache</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aandq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aandq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aandq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aandq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aandq:0" aria-labelledby="tab:R2aandq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
package_manager_fixcache
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aandq:1" aria-labelledby="tab:R2aandq: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:R2eandq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eandq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eandq:0" aria-labelledby="tab:R2eandq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_seems_ok_now"</span>: <span class="token number">1</span></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">"command"</span>: <span class="token string">"package_manager_fixcache"</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/Package-Manager-Settings/operation/delete_rpm_version" data-section-id="tag/Package-Manager-Settings/operation/delete_rpm_version" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_rpm_version" id="operation/delete_rpm_version" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Package-Manager-Settings/operation/delete_rpm_version" aria-label="tag/Package-Manager-Settings/operation/delete_rpm_version"></a>Remove rpm.versions system configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes RPM data. When you call this function, it performs the same
actions as the following command:</p>
<p><code>/usr/local/cpanel/scripts/update_local_rpm_versions --del section.key value</code></p>
<p>For more information, read our
<a href="https://docs.cpanel.net/knowledge-base/rpm-versions/introduction-to-the-rpm-versions-system/">rpm.versions system</a>
documentation.</p>
<p><strong>Note:</strong></p>
<p>After you call this function, we <strong>strongly</strong> recommend that you run the
<code>/usr/local/cpanel/scripts/check_cpanel_pkgs</code> script.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes RPM data. When you call this function, it performs the same
actions as the following command:</p>
<p><code>/usr/local/cpanel/scripts/update_local_rpm_versions --del section.key value</code></p>
<p>For more information, read our
<a href="https://docs.cpanel.net/knowledge-base/rpm-versions/introduction-to-the-rpm-versions-system/">rpm.versions system</a>
documentation.</p>
<p><strong>Note:</strong></p>
<p>After you call this function, we <strong>strongly</strong> recommend that you run the
<code>/usr/local/cpanel/scripts/check_cpanel_pkgs</code> script.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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" 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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=3rdparty</span></div><div><div html="<p>The <a href="https://docs.cpanel.net/knowledge-base/rpm-versions/rpm-targets/">RPM&#39;s target</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://docs.cpanel.net/knowledge-base/rpm-versions/rpm-targets/">RPM's target</a>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="section" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">section</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">section=rpm_groups</span></div><div><div html="<p>The RPM&#39;s section within the <code>rpm.versions</code> file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The RPM's section within the <code>rpm.versions</code> file.</p>
</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><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">value=cpanel-pcre</span></div><div><div html="<p>The RPM name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The RPM 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/delete_rpm_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/delete_rpm_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:R2abndq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abndq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abndq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abndq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abndq:0" aria-labelledby="tab:R2abndq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
delete_rpm_version <span class="token punctuation">\</span>
<span class="token assign-left variable">section</span><span class="token operator">=</span><span class="token string">'rpm_groups'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">key</span><span class="token operator">=</span><span class="token string">'3rdparty'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">value</span><span class="token operator">=</span><span class="token string">'cpanel-pcre'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abndq:1" aria-labelledby="tab:R2abndq: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:R2ebndq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebndq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebndq:0" aria-labelledby="tab:R2ebndq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="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">"delete_rpm_version"</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/Package-Manager-Settings/operation/edit_rpm_version" data-section-id="tag/Package-Manager-Settings/operation/edit_rpm_version" class="sc-dntaoT ceciOs"><div data-section-id="operation/edit_rpm_version" id="operation/edit_rpm_version" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Package-Manager-Settings/operation/edit_rpm_version" aria-label="tag/Package-Manager-Settings/operation/edit_rpm_version"></a>Update rpm.versions system configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function edits RPM data. When you call this function, it performs the same actions
as the following command:</p>
<p><code>/usr/local/cpanel/scripts/update_local_rpm_versions --edit section.key value</code></p>
<p>For more information, read our
<a href="https://docs.cpanel.net/knowledge-base/rpm-versions/introduction-to-the-rpm-versions-system/">rpm.versions system</a>
documentation.</p>
<p><strong>Note:</strong></p>
<p>After you call this function, we <strong>strongly</strong> recommend that you run the
<code>/usr/local/cpanel/scripts/check_cpanel_pkgs</code> script.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function edits RPM data. When you call this function, it performs the same actions
as the following command:</p>
<p><code>/usr/local/cpanel/scripts/update_local_rpm_versions --edit section.key value</code></p>
<p>For more information, read our
<a href="https://docs.cpanel.net/knowledge-base/rpm-versions/introduction-to-the-rpm-versions-system/">rpm.versions system</a>
documentation.</p>
<p><strong>Note:</strong></p>
<p>After you call this function, we <strong>strongly</strong> recommend that you run the
<code>/usr/local/cpanel/scripts/check_cpanel_pkgs</code> script.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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" 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></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=3rdparty</span></div><div><div html="<p>The RPM&#39;s key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The RPM's key.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="section" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">section</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">section=rpm_groups</span></div><div><div html="<p>The RPM&#39;s section.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The RPM's section.</p>
</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><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">value=cpanel-pcre</span></div><div><div html="<p>The RPM&#39;s value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The RPM's 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/edit_rpm_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/edit_rpm_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:R2acndq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acndq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acndq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acndq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acndq:0" aria-labelledby="tab:R2acndq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
edit_rpm_version <span class="token punctuation">\</span>
<span class="token assign-left variable">section</span><span class="token operator">=</span><span class="token string">'rpm_groups'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">key</span><span class="token operator">=</span><span class="token string">'3rdparty'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">value</span><span class="token operator">=</span><span class="token string">'cpanel-pcre'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acndq:1" aria-labelledby="tab:R2acndq: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:R2ecndq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecndq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecndq:0" aria-labelledby="tab:R2ecndq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="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">"edit_rpm_version"</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/cPanel-Account-Transfer" data-section-id="tag/cPanel-Account-Transfer" 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-Transfer" aria-label="tag/cPanel-Account-Transfer"></a>cPanel Account Transfer</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Transfers / cPanel Account Transfer</p>
"><p>Transfers / cPanel Account Transfer</p>
</div></div></div><div id="tag/cPanel-Account-Transfer/operation/abort_transfer_session" data-section-id="tag/cPanel-Account-Transfer/operation/abort_transfer_session" class="sc-dntaoT ceciOs"><div data-section-id="operation/abort_transfer_session" id="operation/abort_transfer_session" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Transfer/operation/abort_transfer_session" aria-label="tag/cPanel-Account-Transfer/operation/abort_transfer_session"></a>Stop transfer session<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function aborts an active transfer session.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function aborts an active transfer session.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="transfer_session_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">transfer_session_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">transfer_session_id=exampleservercopya20140206192428NtyW</span></div><div><div html="<p>The transfer session&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The transfer session'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="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">/abort_transfer_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/abort_transfer_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:R2a9jea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9jea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9jea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9jea:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9jea:0" aria-labelledby="tab:R2a9jea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
abort_transfer_session <span class="token punctuation">\</span>
<span class="token assign-left variable">transfer_session_id</span><span class="token operator">=</span><span class="token string">'exampleservercopya20140206192428NtyW'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9jea:1" aria-labelledby="tab:R2a9jea: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:R2e9jea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9jea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9jea:0" aria-labelledby="tab:R2e9jea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"abort_transfer_session"</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/cPanel-Account-Transfer/operation/create_remote_root_transfer_session" data-section-id="tag/cPanel-Account-Transfer/operation/create_remote_root_transfer_session" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_remote_root_transfer_session" id="operation/create_remote_root_transfer_session" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Transfer/operation/create_remote_root_transfer_session" aria-label="tag/cPanel-Account-Transfer/operation/create_remote_root_transfer_session"></a>Create remote server transfer session as root user<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates a transfer session as the <code>root</code> user.</p>
<p><strong>Important:</strong></p>
<p> For information about the ports that cPanel &amp; WHM uses, read our <a href="https://go.cpanel.net/firewall">How to Configure Your Firewall for cPanel Services</a> documentation.</p>
<p><strong>Note:</strong></p>
<p> For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</a> documentation.</p>
<h3 id="authentication">Authentication</h3>
<p>There are several methods that you can use to authenticate a transfer session with the remote server:</p>
<h4 id="authenticate-as-root">Authenticate as root</h4>
<p>If you use SSH to authenticate as the <code>root</code> user, the remote server&#39;s SSH must accept <code>root</code> logins. For more information read <a href="https://linux.die.net/man/5/sshd_config">OpenSSH&#39;s <code>sshd_config</code></a> documentation.</p>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Value</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td><code>root</code></td>
</tr>
<tr>
<td><code>password</code></td>
<td><code>root</code>&#39;s password</td>
</tr>
</tbody></table>
<p>You can also use an SSH public key to authenticate the <code>root</code> user. If the SSH public key is encrypted, include the SSH key&#39;s passphrase.</p>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Value if the SSH Key is not encrypted</th>
<th>Value if the SSH Key is encrypted</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td><code>root</code></td>
<td><code>root</code></td>
</tr>
<tr>
<td><code>sshkey_name</code></td>
<td>The <code>root</code> user&#39;s SSH key.</td>
<td>The <code>root</code> user&#39;s SSH key.</td>
</tr>
<tr>
<td><code>sshkey_passphrase</code></td>
<td><em>(none)</em></td>
<td>The <code>root</code> user&#39;s SSH key passphrase.</td>
</tr>
</tbody></table>
<h4 id="authenticate-as-a-user">Authenticate as a user</h4>
<p>Many server administrators do not permit direct <code>root</code> logins via SSH on their servers.</p>
<ul>
<li>If the remote server forbids root logins, you <strong>must</strong> use another user and their password on the remote server, and then escalate to the <code>root</code> user. For more information read <a href="https://linux.die.net/man/5/sshd_config">OpenSSH&#39;s <code>sshd_config</code></a> documentation.</li>
<li>If the system administrator used WHM&#39;s <a href="https://go.cpanel.net/whmdocsManageWheelGroupUsers"><em>Manage Wheel Group Users</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Security Center &gt;&gt; Manage Wheel Group Users</em>) to grant the user <code>su</code> access, then you will need to specify <code>su</code> and the <code>root</code> password.</li>
<li>If the user has <code>sudo</code> access, you do <strong>not</strong> need the <code>root</code> password.</li>
</ul>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Value if the user has sudo access</th>
<th>Value if the user has su access</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td>The username.</td>
<td>The username.</td>
</tr>
<tr>
<td><code>password</code></td>
<td>The user&#39;s password.</td>
<td>The user&#39;s password.</td>
</tr>
<tr>
<td><code>root_escalation_method</code></td>
<td><code>sudo</code></td>
<td><code>su</code></td>
</tr>
<tr>
<td><code>root_password</code></td>
<td><em>(none)</em></td>
<td>The <code>root</code> user&#39;s password.</td>
</tr>
</tbody></table>
<p>You can also use an SSH public key instead of a password to authenticate that user. If the SSH public key is encrypted, include the SSH key&#39;s passphrase.</p>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>sudo</th>
<th>su</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td>The username.</td>
<td>The username.</td>
</tr>
<tr>
<td><code>sshkey_name</code></td>
<td>The user&#39;s SSH key.</td>
<td>The user&#39;s SSH key.</td>
</tr>
<tr>
<td><code>sshkey_passphrase</code> (If encrypted)</td>
<td>The user&#39;s SSH key passphrase.</td>
<td>The user&#39;s SSH key passphrase.</td>
</tr>
<tr>
<td><code>root_escalation_method</code></td>
<td><code>sudo</code></td>
<td><code>su</code></td>
</tr>
<tr>
<td><code>root_password</code></td>
<td><em>(none)</em></td>
<td>The <code>root</code> user&#39;s password.</td>
</tr>
</tbody></table>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a transfer session as the <code>root</code> user.</p>
<p><strong>Important:</strong></p>
<p> For information about the ports that cPanel & WHM uses, read our <a href="https://go.cpanel.net/firewall">How to Configure Your Firewall for cPanel Services</a> documentation.</p>
<p><strong>Note:</strong></p>
<p> For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</a> documentation.</p>
<h3 id="authentication">Authentication</h3>
<p>There are several methods that you can use to authenticate a transfer session with the remote server:</p>
<h4 id="authenticate-as-root">Authenticate as root</h4>
<p>If you use SSH to authenticate as the <code>root</code> user, the remote server's SSH must accept <code>root</code> logins. For more information read <a href="https://linux.die.net/man/5/sshd_config">OpenSSH's <code>sshd_config</code></a> documentation.</p>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Value</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td><code>root</code></td>
</tr>
<tr>
<td><code>password</code></td>
<td><code>root</code>'s password</td>
</tr>
</tbody></table>
<p>You can also use an SSH public key to authenticate the <code>root</code> user. If the SSH public key is encrypted, include the SSH key's passphrase.</p>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Value if the SSH Key is not encrypted</th>
<th>Value if the SSH Key is encrypted</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td><code>root</code></td>
<td><code>root</code></td>
</tr>
<tr>
<td><code>sshkey_name</code></td>
<td>The <code>root</code> user's SSH key.</td>
<td>The <code>root</code> user's SSH key.</td>
</tr>
<tr>
<td><code>sshkey_passphrase</code></td>
<td><em>(none)</em></td>
<td>The <code>root</code> user's SSH key passphrase.</td>
</tr>
</tbody></table>
<h4 id="authenticate-as-a-user">Authenticate as a user</h4>
<p>Many server administrators do not permit direct <code>root</code> logins via SSH on their servers.</p>
<ul>
<li>If the remote server forbids root logins, you <strong>must</strong> use another user and their password on the remote server, and then escalate to the <code>root</code> user. For more information read <a href="https://linux.die.net/man/5/sshd_config">OpenSSH's <code>sshd_config</code></a> documentation.</li>
<li>If the system administrator used WHM's <a href="https://go.cpanel.net/whmdocsManageWheelGroupUsers"><em>Manage Wheel Group Users</em></a> interface (<em>WHM >> Home >> Security Center >> Manage Wheel Group Users</em>) to grant the user <code>su</code> access, then you will need to specify <code>su</code> and the <code>root</code> password.</li>
<li>If the user has <code>sudo</code> access, you do <strong>not</strong> need the <code>root</code> password.</li>
</ul>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Value if the user has sudo access</th>
<th>Value if the user has su access</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td>The username.</td>
<td>The username.</td>
</tr>
<tr>
<td><code>password</code></td>
<td>The user's password.</td>
<td>The user's password.</td>
</tr>
<tr>
<td><code>root_escalation_method</code></td>
<td><code>sudo</code></td>
<td><code>su</code></td>
</tr>
<tr>
<td><code>root_password</code></td>
<td><em>(none)</em></td>
<td>The <code>root</code> user's password.</td>
</tr>
</tbody></table>
<p>You can also use an SSH public key instead of a password to authenticate that user. If the SSH public key is encrypted, include the SSH key's passphrase.</p>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>sudo</th>
<th>su</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td>The username.</td>
<td>The username.</td>
</tr>
<tr>
<td><code>sshkey_name</code></td>
<td>The user's SSH key.</td>
<td>The user's SSH key.</td>
</tr>
<tr>
<td><code>sshkey_passphrase</code> (If encrypted)</td>
<td>The user's SSH key passphrase.</td>
<td>The user's SSH key passphrase.</td>
</tr>
<tr>
<td><code>root_escalation_method</code></td>
<td><code>sudo</code></td>
<td><code>su</code></td>
</tr>
<tr>
<td><code>root_password</code></td>
<td><em>(none)</em></td>
<td>The <code>root</code> user's password.</td>
</tr>
</tbody></table>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="comm_transport" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">comm_transport</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"ssh"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ssh"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"whostmgr"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"whostmgr_insecure"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">comm_transport=ssh</span></div><div><div html="<p>The method by which the transfer system will execute commands on the remote system.</p>
<ul>
<li><code>ssh</code> — Use SSH. The function uses the remote server&#39;s indicated SSH <code>port</code> value.</li>
<li><code>whostmgr</code> — Use the remote server&#39;s secure WHM port. This will reject invalid TLS handshakes.</li>
<li><code>whostmgr_insecure</code> — Use the remote server&#39;s secure WHM port, but <strong>ignores</strong> any TLS verification failures.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The method by which the transfer system will execute commands on the remote system.</p>
<ul>
<li><code>ssh</code> — Use SSH. The function uses the remote server's indicated SSH <code>port</code> value.</li>
<li><code>whostmgr</code> — Use the remote server's secure WHM port. This will reject invalid TLS handshakes.</li>
<li><code>whostmgr_insecure</code> — Use the remote server's secure WHM port, but <strong>ignores</strong> any TLS verification failures.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="compressed" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">compressed</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">compressed=1</span></div><div><div html="<p>Whether to compress data before transfer.</p>
<ul>
<li><code>1</code> — Compress.</li>
<li><code>0</code> — Do <strong>not</strong> compress.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to compress data before transfer.</p>
<ul>
<li><code>1</code> — Compress.</li>
<li><code>0</code> — Do <strong>not</strong> compress.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="copy_reseller_privs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">copy_reseller_privs</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">copy_reseller_privs=1</span></div><div><div html="<p>Whether to transfer reseller privileges.</p>
<ul>
<li><code>1</code> — Transfer.</li>
<li><code>0</code> — Do <strong>not</strong> transfer.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to transfer reseller privileges.</p>
<ul>
<li><code>1</code> — Transfer.</li>
<li><code>0</code> — Do <strong>not</strong> transfer.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="enable_custom_pkgacct" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enable_custom_pkgacct</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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_custom_pkgacct=1</span></div><div><div html="<p>Whether to use a custom <code>pkgacct</code> scripts on the remote server for the transfer session.</p>
<ul>
<li><code>1</code> — Use a custom <code>pkgacct</code> script.</li>
<li><code>0</code> — Do <strong>not</strong> use a custom script.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use a custom <code>pkgacct</code> scripts on the remote server for the transfer session.</p>
<ul>
<li><code>1</code> — Use a custom <code>pkgacct</code> script.</li>
<li><code>0</code> — Do <strong>not</strong> use a custom script.</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=192.168.0.0</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="low_priority" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">low_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></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">low_priority=1</span></div><div><div html="<p>Whether to run the remote server processes at low priority in order to reduce impact on server performance.</p>
<ul>
<li><code>1</code> — Run at low priority.</li>
<li><code>0</code> — Run at high priority.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to run the remote server processes at low priority in order to reduce impact on server performance.</p>
<ul>
<li><code>1</code> — Run at low priority.</li>
<li><code>0</code> — Run at high priority.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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 username&#39;s password.</p>
<p><strong>Note:</strong></p>
<p> Use this parameter if you will authenticate to the remote server with a password. Do <strong>not</strong> use this parameter if you will authenticate to the remote server with an SSH key.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username's password.</p>
<p><strong>Note:</strong></p>
<p> Use this parameter if you will authenticate to the remote server with a password. Do <strong>not</strong> use this parameter if you will authenticate to the remote server with an SSH key.</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">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 remote server&#39;s SSH port number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server's SSH port number.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="restore_threads" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">restore_threads</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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">restore_threads=1</span></div><div><div html="<p>The number of CPU threads to use for restore sessions.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of CPU threads to use for restore sessions.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="root_escalation_method" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">root_escalation_method</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"su"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"sudo"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">root_escalation_method=sudo</span></div><div><div html="<p>The escalation method to use to connect to the remote server.</p>
<ul>
<li><code>su</code></li>
<li><code>sudo</code></li>
</ul>
<p><strong>Note:</strong></p>
<p> Use this parameter if the <code>sshd_config</code> file&#39;s <code>PermitRootLogin</code> value is <code>No</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The escalation method to use to connect to the remote server.</p>
<ul>
<li><code>su</code></li>
<li><code>sudo</code></li>
</ul>
<p><strong>Note:</strong></p>
<p> Use this parameter if the <code>sshd_config</code> file's <code>PermitRootLogin</code> value is <code>No</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="root_password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">root_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">root_password=123456luggage</span></div><div><div html="<p><code>root</code>&#39;s password on the remote server.</p>
<p><strong>Note:</strong></p>
<p> Use this parameter if the <code>sshd_config</code> file&#39;s <code>PermitRootLogin</code> value is <code>No</code> and you will use the <code>root</code> user&#39;s password to escalate access.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p><code>root</code>'s password on the remote server.</p>
<p><strong>Note:</strong></p>
<p> Use this parameter if the <code>sshd_config</code> file's <code>PermitRootLogin</code> value is <code>No</code> and you will use the <code>root</code> user's password to escalate access.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="sshkey_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">sshkey_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">sshkey_name=FrancisScott</span></div><div><div html="<p>The SSH key&#39;s name.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Use this parameter if you will authenticate to the remote server with an SSH key. Do <strong>not</strong> use this parameter if you will authenticate to the remote server with a password.</li>
<li>SSH keys are available in WHM&#39;s <a href="https://go.cpanel.net/whmdocsManagerootsSSHKeys"><em>Manage root&#39;s SSH Keys</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Security Center &gt;&gt; Manage root’s SSH Keys</em>).</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH key's name.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Use this parameter if you will authenticate to the remote server with an SSH key. Do <strong>not</strong> use this parameter if you will authenticate to the remote server with a password.</li>
<li>SSH keys are available in WHM's <a href="https://go.cpanel.net/whmdocsManagerootsSSHKeys"><em>Manage root's SSH Keys</em></a> interface (<em>WHM >> Home >> Security Center >> Manage root’s SSH Keys</em>).</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="sshkey_passphrase" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">sshkey_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">sshkey_passphrase=kkwtoowoygidsa</span></div><div><div html="<p>The SSH key&#39;s passphrase.</p>
<p><strong>Note:</strong></p>
<p> Use this parameter if you will authenticate to the remote server with an SSH key, and the key is encrypted.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH key's passphrase.</p>
<p><strong>Note:</strong></p>
<p> Use this parameter if you will authenticate to the remote server with an SSH key, and the key is encrypted.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="transfer_threads" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">transfer_threads</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="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">transfer_threads=1</span></div><div><div html="<p>The number of CPU threads to use for transfer sessions.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of CPU threads to use for transfer sessions.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="unencrypted" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">unencrypted</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">unencrypted=0</span></div><div><div html="<p>Whether to not use SSL to encrypt data.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> use SSL.</li>
<li><code>0</code> — Use SSL.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to not use SSL to encrypt data.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> use SSL.</li>
<li><code>0</code> — Use SSL.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="unrestricted_restore" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">unrestricted_restore</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">unrestricted_restore=1</span></div><div><div html="<p>Whether to skip the Restricted Restore system.</p>
<ul>
<li><code>1</code> — Skip.</li>
<li><code>0</code> — Do <strong>not</strong> skip.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If you want to pass the <code>force</code> parameter in the WHM API 1 <code>enqueue_transfer_item</code> function, you <strong>must</strong> set this parameter to a value of <code>0</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip the Restricted Restore system.</p>
<ul>
<li><code>1</code> — Skip.</li>
<li><code>0</code> — Do <strong>not</strong> skip.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If you want to pass the <code>force</code> parameter in the WHM API 1 <code>enqueue_transfer_item</code> function, you <strong>must</strong> set this parameter to a value of <code>0</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="use_backups" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">use_backups</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">use_backups=1</span></div><div><div html="<p>Whether to use an existing backup instead of packaging the data again if the backup is less than 24 hours old.</p>
<ul>
<li><code>1</code> — Use an existing backup.</li>
<li><code>0</code> — Package the data.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use an existing backup instead of packaging the data again if the backup is less than 24 hours old.</p>
<ul>
<li><code>1</code> — Use an existing backup.</li>
<li><code>0</code> — Package the data.</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=root</span></div><div><div html="<p>The username to use to connect to the remote server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username to use to connect to the remote 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/create_remote_root_transfer_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/create_remote_root_transfer_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:R2aajea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aajea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aajea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aajea:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aajea:0" aria-labelledby="tab:R2aajea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
create_remote_root_transfer_session <span class="token punctuation">\</span>
<span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'192.168.0.0'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'root'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">transfer_threads</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">restore_threads</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">unrestricted_restore</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">comm_transport</span><span class="token operator">=</span><span class="token string">'ssh'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">copy_reseller_privs</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">compressed</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">unencrypted</span><span class="token operator">=</span><span class="token string">'0'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">use_backups</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">low_priority</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">enable_custom_pkgacct</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:R2aajea:1" aria-labelledby="tab:R2aajea: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:R2eajea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eajea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eajea:0" aria-labelledby="tab:R2eajea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"analyze_rawout"</span>: <span class="token string">"Fetching information from remote host: \\u201c10.1.100.35\\u201d \\u2026 \\u2026\\nDone\\nFetching information from remote host: \\u201c10.1.100.35\\u201d \\u2026 \\u2026\\nDone\\n\","</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_rawout"</span>: <span class="token string">"Basic credential check \\u2026 \\u2026\\nDone\\nFetching information from remote host: \\u201c10.1.100.35\\u201d \\u2026 \\u2026\\nDone\\nFetching WHM Version \\u2026\\nDone\\nTesting \\u201cvm5.docs.cpanel.net\\u201d for transfer streaming support with password authentication....<strong>Streaming Supported</strong>\\nRemote Server Type: \\u201cWHM1130\\u201d\\n\","</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"transfer_session_id"</span>: <span class="token string">"vm5docscpanelcopya20140430200606V06z"</span></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">"command"</span>: <span class="token string">"create_remote_root_transfer_session"</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/cPanel-Account-Transfer/operation/enqueue_transfer_item" data-section-id="tag/cPanel-Account-Transfer/operation/enqueue_transfer_item" class="sc-dntaoT ceciOs"><div data-section-id="operation/enqueue_transfer_item" id="operation/enqueue_transfer_item" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Transfer/operation/enqueue_transfer_item" aria-label="tag/cPanel-Account-Transfer/operation/enqueue_transfer_item"></a>Add module to transfer session<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds a transfer session to a queue. For more information about how this function works with other
functions in the transfer and restore process, read our
<a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</a> documentation.</p>
<p><strong>Important:</strong></p>
<p>The <code>module</code> parameter determines which additional parameters to use with the function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds a transfer session to a queue. For more information about how this function works with other
functions in the transfer and restore process, read our
<a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</a> documentation.</p>
<p><strong>Important:</strong></p>
<p>The <code>module</code> parameter determines which additional parameters to use with the function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></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/x-www-form-urlencoded</span></h5><div html="<p>An enqueue transfer item.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>An enqueue transfer item.</p>
</div><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="localuser" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">localuser</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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><div html="<p>The local account&#39;s username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The local account's username.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The transfer system module.</p>
<ul>
<li><code>LegacyAccountBackup</code> — This module restores legacy-account backup files.</li>
<li><code>FeatureListRemoteRoot</code> — This module transfers the feature list from the remote server.</li>
<li><code>PackageRemoteRoot</code> — This module transfers the package settings.</li>
<li><code>AccountLocal</code> — This module restores backup files.</li>
<li><code>AccountRemoteRoot</code> — This module uses the <code>root</code> credentials to transfer account settings that are not a part of a package.</li>
<li><code>AccountRemoteUser</code> — This module uses the account&#39;s user credentials to transfer account settings that are not a part of a package.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>The <code>module</code> parameter determines which additional parameters to use with the function.</li>
<li>You <strong>must</strong> perform each module action as a separate step.</li>
</ul>
<p>When you call this function, you <strong>must</strong> include the additional parameters for the desired transfer system module. Select a module from the menu to view its required additional parameters:</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The transfer system module.</p>
<ul>
<li><code>LegacyAccountBackup</code> — This module restores legacy-account backup files.</li>
<li><code>FeatureListRemoteRoot</code> — This module transfers the feature list from the remote server.</li>
<li><code>PackageRemoteRoot</code> — This module transfers the package settings.</li>
<li><code>AccountLocal</code> — This module restores backup files.</li>
<li><code>AccountRemoteRoot</code> — This module uses the <code>root</code> credentials to transfer account settings that are not a part of a package.</li>
<li><code>AccountRemoteUser</code> — This module uses the account's user credentials to transfer account settings that are not a part of a package.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>The <code>module</code> parameter determines which additional parameters to use with the function.</li>
<li>You <strong>must</strong> perform each module action as a separate step.</li>
</ul>
<p>When you call this function, you <strong>must</strong> include the additional parameters for the desired transfer system module. Select a module from the menu to view its required additional parameters:</p>
</div></div><div class="sc-diYFot jsRqjj"><svg class="sc-kZrBCu bweot" 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="AccountLocal" selected="">AccountLocal</option><option value="AccountRemoteRoot">AccountRemoteRoot</option><option value="AccountRemoteUser">AccountRemoteUser</option><option value="FeatureListRemoteRoot">FeatureListRemoteRoot</option><option value="LegacyAccountBackup">LegacyAccountBackup</option><option value="PackageRemoteRoot">PackageRemoteRoot</option></select><label>AccountLocal</label></div></div></td></tr><tr class=""><td kind="field" title="transfer_session_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">transfer_session_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><div html="<p>The transfer session&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The transfer session's ID.</p>
</div></div></div></td></tr><tr class=""><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><div html="<p>The account to transfer.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account to transfer.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="customip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">customip</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="<p>The custom IP address to assign to the transferred account.</p>
<p><strong>Note:</strong></p>
<p>This parameter requires that the <code>ip</code> parameter has a value of <code>1</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The custom IP address to assign to the transferred account.</p>
<p><strong>Note:</strong></p>
<p>This parameter requires that the <code>ip</code> parameter has a value of <code>1</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="detected_remote_user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">detected_remote_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><div html="<p>The user account name that the remote server returns when you query the user account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user account name that the remote server returns when you query the user account.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-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><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=""><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"> <!-- -->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><div html="<p>Whether to overwrite an account with an identical username.</p>
<ul>
<li><code>1</code> — Overwrite the account.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite the account.</li>
</ul>
<p>This parameter performs the following actions:</p>
<ul>
<li>Restores the cPanel account on the destination server.</li>
<li>Overwrites all account settings, data, and databases.</li>
<li>Ignores errors and warnings for naming conflicts.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>The values you enter for the <code>user</code> and <code>localuser</code> parameters <strong>must</strong> match.</li>
<li>You cannot use this parameter if you called the WHM API 1 <code>create_remote_root_transfer_session</code> function with the <code>unrestricted_restore</code> parameter set to <code>1</code>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to overwrite an account with an identical username.</p>
<ul>
<li><code>1</code> — Overwrite the account.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite the account.</li>
</ul>
<p>This parameter performs the following actions:</p>
<ul>
<li>Restores the cPanel account on the destination server.</li>
<li>Overwrites all account settings, data, and databases.</li>
<li>Ignores errors and warnings for naming conflicts.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>The values you enter for the <code>user</code> and <code>localuser</code> parameters <strong>must</strong> match.</li>
<li>You cannot use this parameter if you called the WHM API 1 <code>create_remote_root_transfer_session</code> function with the <code>unrestricted_restore</code> parameter set to <code>1</code>.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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">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><div html="<p>Whether to assign a dedicated IP address to the transferred account.</p>
<ul>
<li><code>1</code> — Assign a dedicated IP address.</li>
<li><code>0</code> — Do <strong>not</strong> assign a dedicated IP address.</li>
</ul>
<p><strong>Note:</strong></p>
<p>If no dedicated IP address exists, the system assigns the account to a shared IP address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to assign a dedicated IP address to the transferred account.</p>
<ul>
<li><code>1</code> — Assign a dedicated IP address.</li>
<li><code>0</code> — Do <strong>not</strong> assign a dedicated IP address.</li>
</ul>
<p><strong>Note:</strong></p>
<p>If no dedicated IP address exists, the system assigns the account to a shared IP address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="mail_location" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand mail_location"><span class="property-name">mail_location</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td 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">".existing"</span></div> <div><div html="<p>The server on which the account&#39;s email will reside after it completes the transfer.</p>
<ul>
<li><code>.local</code> — The local server.</li>
<li><code>.existing</code> — Use the location defined in the account&#39;s backup data.</li>
<li>The alias (friendly name) of a remote <a href="https://go.cpanel.net/whmdocsLinkServerNodes">cPanel &amp; WHM linked server node.</a>. For example, the <code>example-alias</code> for the <code>servernode.example.com</code> domain.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The system will use the <code>.local</code> option if:</p>
<ul>
<li>The system cannot use the cPanel &amp; WHM linked server node when you call the <code>.existing</code> option.</li>
<li>The cPanel &amp; WHM linked server node&#39;s alias (friendly name) is invalid.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server on which the account's email will reside after it completes the transfer.</p>
<ul>
<li><code>.local</code> — The local server.</li>
<li><code>.existing</code> — Use the location defined in the account's backup data.</li>
<li>The alias (friendly name) of a remote <a href="https://go.cpanel.net/whmdocsLinkServerNodes">cPanel & WHM linked server node.</a>. For example, the <code>example-alias</code> for the <code>servernode.example.com</code> domain.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The system will use the <code>.local</code> option if:</p>
<ul>
<li>The system cannot use the cPanel & WHM linked server node when you call the <code>.existing</code> option.</li>
<li>The cPanel & WHM linked server node's alias (friendly name) is invalid.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="overwrite_sameowner_dbs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">overwrite_sameowner_dbs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether to allow the system to overwrite the account&#39;s existing databases with the databases in the backup file.</p>
<ul>
<li><code>1</code> — Overwrite.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the system to overwrite the account's existing databases with the databases in the backup file.</p>
<ul>
<li><code>1</code> — Overwrite.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="overwrite_sameowner_dbusers" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">overwrite_sameowner_dbusers</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether to allow the system to overwrite the account&#39;s existing database users with the database users in the backup file.</p>
<ul>
<li><code>1</code> — Overwrite.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to allow the system to overwrite the account's existing database users with the database users in the backup file.</p>
<ul>
<li><code>1</code> — Overwrite.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="overwrite_with_delete" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">overwrite_with_delete</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether to replace and delete <strong>all</strong> directories and files on the destination server.</p>
<ul>
<li><code>1</code> — Overwrite.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite.</li>
</ul>
<p><strong>Warning:</strong></p>
<p>If you use this parameter, the system deletes <strong>every</strong> directory and file on the destination server. The system does <strong>not</strong> delete the directories and files from the source server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to replace and delete <strong>all</strong> directories and files on the destination server.</p>
<ul>
<li><code>1</code> — Overwrite.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite.</li>
</ul>
<p><strong>Warning:</strong></p>
<p>If you use this parameter, the system deletes <strong>every</strong> directory and file on the destination server. The system does <strong>not</strong> delete the directories and files from the source server.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="replaceip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">replaceip</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"all"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"basic"</span> </div> <div><div html="<p>The lines in the domain&#39;s zonefile to replace with the new IP address.</p>
<ul>
<li><code>all</code> — Replace all of the matching <code>A</code> record addresses in the zone file with the new IP address, including custom <code>A</code> records.</li>
<li><code>basic</code> — Replace <strong>only</strong> the cPanel-managed <code>A</code> records for this IP address. This includes the main domain and any <a href="https://go.cpanel.net/ServiceProxySubdomains">service subdomains</a>.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The lines in the domain's zonefile to replace with the new IP address.</p>
<ul>
<li><code>all</code> — Replace all of the matching <code>A</code> record addresses in the zone file with the new IP address, including custom <code>A</code> records.</li>
<li><code>basic</code> — Replace <strong>only</strong> the cPanel-managed <code>A</code> records for this IP address. This includes the main domain and any <a href="https://go.cpanel.net/ServiceProxySubdomains">service subdomains</a>.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="reseller" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">reseller</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether to make the account a reseller.</p>
<ul>
<li><code>1</code> — Make the account a reseller account.</li>
<li><code>0</code> — Do <strong>not</strong> make the account a reseller account.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to make the account a reseller.</p>
<ul>
<li><code>1</code> — Make the account a reseller account.</li>
<li><code>0</code> — Do <strong>not</strong> make the account a reseller account.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="shared_mysql_server" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">shared_mysql_server</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether one of the following conditions is true:</p>
<ul>
<li>The target and remote servers share the same remote MySQL server.</li>
<li>The target server is the remote MySQL server for the remote server.</li>
<li>The remote server is the remote MySQL server for the target server.</li>
</ul>
<p>Value:</p>
<ul>
<li><code>1</code> — One is true.</li>
<li><code>0</code> — None are true.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether one of the following conditions is true:</p>
<ul>
<li>The target and remote servers share the same remote MySQL server.</li>
<li>The target server is the remote MySQL server for the remote server.</li>
<li>The remote server is the remote MySQL server for the target server.</li>
</ul>
<p>Value:</p>
<ul>
<li><code>1</code> — One is true.</li>
<li><code>0</code> — None are true.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="size" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">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"> <!-- -->>= 1<!-- --> </span></span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div> <div><div html="<p>The size of the content to transfer, in bytes.
The restore system uses this value to determine the best filesystem
partition for the restored account’s home directory. For best
results, give as accurate of a value as possible.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The size of the content to transfer, in bytes.
The restore system uses this value to determine the best filesystem
partition for the restored account’s home directory. For best
results, give as accurate of a value as possible.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="skipaccount" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipaccount</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether to skip the recreation of the account.</p>
<ul>
<li><code>1</code> — Skip.</li>
<li><code>0</code> — Restore.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>The values you enter for the <code>user</code> and <code>localuser</code> parameters <strong>must</strong> match.</li>
<li>This parameter is similar to the <code>force</code> parameter, but performs none of the account creation steps.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip the recreation of the account.</p>
<ul>
<li><code>1</code> — Skip.</li>
<li><code>0</code> — Restore.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>The values you enter for the <code>user</code> and <code>localuser</code> parameters <strong>must</strong> match.</li>
<li>This parameter is similar to the <code>force</code> parameter, but performs none of the account creation steps.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skipacctdb" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipacctdb</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether to skip the transfer of the account&#39;s databases.</p>
<ul>
<li><code>1</code> — Skip.</li>
<li><code>0</code> — Restore.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip the transfer of the account's databases.</p>
<ul>
<li><code>1</code> — Skip.</li>
<li><code>0</code> — Restore.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skipbwdata" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipbwdata</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether to skip the transfer of the account&#39;s bandwidth data.</p>
<ul>
<li><code>1</code> — Skip.</li>
<li><code>0</code> — Restore.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip the transfer of the account's bandwidth data.</p>
<ul>
<li><code>1</code> — Skip.</li>
<li><code>0</code> — Restore.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="skiphomedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skiphomedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether to skip the contents of the home directory.</p>
<ul>
<li><code>1</code> — Skip.</li>
<li><code>0</code> — Restore.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip the contents of the home directory.</p>
<ul>
<li><code>1</code> — Skip.</li>
<li><code>0</code> — Restore.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="skipres" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skipres</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>Whether to skip restoration of the account&#39;s reseller permissions.</p>
<ul>
<li><code>1</code> — Skip.</li>
<li><code>0</code> — Restore.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip restoration of the account's reseller permissions.</p>
<ul>
<li><code>1</code> — Skip.</li>
<li><code>0</code> — Restore.</li>
</ul>
</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="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">/enqueue_transfer_item</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/enqueue_transfer_item</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abjea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abjea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abjea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abjea: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:R2abjea:0" aria-labelledby="tab:R2abjea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <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>
enqueue_transfer_item
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abjea:1" aria-labelledby="tab:R2abjea: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:R2ebjea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebjea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebjea:0" aria-labelledby="tab:R2ebjea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"enqueue_transfer_item"</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/cPanel-Account-Transfer/operation/pause_transfer_session" data-section-id="tag/cPanel-Account-Transfer/operation/pause_transfer_session" class="sc-dntaoT ceciOs"><div data-section-id="operation/pause_transfer_session" id="operation/pause_transfer_session" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Transfer/operation/pause_transfer_session" aria-label="tag/cPanel-Account-Transfer/operation/pause_transfer_session"></a>Suspend active transfer session<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function pauses an active transfer session.</p>
<p><strong>Note:</strong></p>
<p>For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function pauses an active transfer session.</p>
<p><strong>Note:</strong></p>
<p>For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</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="transfer_session_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">transfer_session_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">transfer_session_id=exampleservercopya20140206192428NtyW</span></div><div><div html="<p>The transfer session&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The transfer session'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="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">/pause_transfer_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/pause_transfer_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:R2acjea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acjea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acjea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acjea:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acjea:0" aria-labelledby="tab:R2acjea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
pause_transfer_session <span class="token punctuation">\</span>
<span class="token assign-left variable">transfer_session_id</span><span class="token operator">=</span><span class="token string">'exampleservercopya20140206192428NtyW'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acjea:1" aria-labelledby="tab:R2acjea: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:R2ecjea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecjea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecjea:0" aria-labelledby="tab:R2ecjea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"pause_transfer_session"</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/cPanel-Account-Transfer/operation/start_transfer_session" data-section-id="tag/cPanel-Account-Transfer/operation/start_transfer_session" class="sc-dntaoT ceciOs"><div data-section-id="operation/start_transfer_session" id="operation/start_transfer_session" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Transfer/operation/start_transfer_session" aria-label="tag/cPanel-Account-Transfer/operation/start_transfer_session"></a>Start or restart transfer session<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function starts or restarts a transfer session.</p>
<p><strong>Note:</strong></p>
<p> For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function starts or restarts a transfer session.</p>
<p><strong>Note:</strong></p>
<p> For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</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="transfer_session_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">transfer_session_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">transfer_session_id=exampleservercopya20140206192428NtyW</span></div><div><div html="<p>The transfer session&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The transfer session'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/start_transfer_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/start_transfer_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:R2adjea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adjea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adjea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adjea:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adjea:0" aria-labelledby="tab:R2adjea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
start_transfer_session <span class="token punctuation">\</span>
<span class="token assign-left variable">transfer_session_id</span><span class="token operator">=</span><span class="token string">'exampleservercopya20140206192428NtyW'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adjea:1" aria-labelledby="tab:R2adjea: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:R2edjea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edjea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edjea:0" aria-labelledby="tab:R2edjea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 number">90210</span></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">"command"</span>: <span class="token string">"start_transfer_session"</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/cPanel-Account-Transfer/operation/create_remote_user_transfer_session" data-section-id="tag/cPanel-Account-Transfer/operation/create_remote_user_transfer_session" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_remote_user_transfer_session" id="operation/create_remote_user_transfer_session" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-Transfer/operation/create_remote_user_transfer_session" aria-label="tag/cPanel-Account-Transfer/operation/create_remote_user_transfer_session"></a>Create remote server transfer session<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates a transfer session with a non-root user to a remote server.</p>
<p><strong>Important:</strong></p>
<ul>
<li>The source and target servers must be able to communicate over port <code>2087</code> to use this feature.</li>
<li>The source and target servers must also be able to communicate over the port that your servers use for SSH connections.</li>
<li>For more information about the ports that cPanel &amp; WHM uses, read our <a href="https://go.cpanel.net/firewall">How to Configure Your Firewall for cPanel &amp; WHM Services</a> documentation.</li>
</ul>
<p><strong>Note:</strong></p>
<p>For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a transfer session with a non-root user to a remote server.</p>
<p><strong>Important:</strong></p>
<ul>
<li>The source and target servers must be able to communicate over port <code>2087</code> to use this feature.</li>
<li>The source and target servers must also be able to communicate over the port that your servers use for SSH connections.</li>
<li>For more information about the ports that cPanel & WHM uses, read our <a href="https://go.cpanel.net/firewall">How to Configure Your Firewall for cPanel & WHM Services</a> documentation.</li>
</ul>
<p><strong>Note:</strong></p>
<p>For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</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="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><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">host=hostname.example.com</span></div><div><div html="<p>The server hostname for the account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server hostname for the 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=12345luggage</span></div><div><div html="<p>The account&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account's password.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="unrestricted_restore" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">unrestricted_restore</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Value<!-- -->:</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">unrestricted_restore=1</span></div><div><div html="<p>Whether to skip the Restricted Restore process.</p>
<ul>
<li><code>1</code> - Skip Restricted Restore.</li>
<li><code>0</code> - Use Restricted Restore.</li>
</ul>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> set this parameter to a value of 1.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip the Restricted Restore process.</p>
<ul>
<li><code>1</code> - Skip Restricted Restore.</li>
<li><code>0</code> - Use Restricted Restore.</li>
</ul>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> set this parameter to a value of 1.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/create_remote_user_transfer_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/create_remote_user_transfer_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:R2aejea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aejea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aejea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aejea:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aejea:0" aria-labelledby="tab:R2aejea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
create_remote_user_transfer_session <span class="token punctuation">\</span>
<span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'hostname.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">unrestricted_restore</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:R2aejea:1" aria-labelledby="tab:R2aejea: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:R2eejea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eejea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eejea:0" aria-labelledby="tab:R2eejea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transfer_session_id"</span>: <span class="token string">"vm5docscpanelnoroo201402251939519hmy"</span></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">"command"</span>: <span class="token string">"create_remote_user_transfer_session"</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/Transfer-Configuration" data-section-id="tag/Transfer-Configuration" 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/Transfer-Configuration" aria-label="tag/Transfer-Configuration"></a>Transfer Configuration</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Transfers / Transfer Configuration</p>
"><p>Transfers / Transfer Configuration</p>
</div></div></div><div id="tag/Transfer-Configuration/operation/remote_basic_credential_check" data-section-id="tag/Transfer-Configuration/operation/remote_basic_credential_check" class="sc-dntaoT ceciOs"><div data-section-id="operation/remote_basic_credential_check" id="operation/remote_basic_credential_check" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Transfer-Configuration/operation/remote_basic_credential_check" aria-label="tag/Transfer-Configuration/operation/remote_basic_credential_check"></a>Validate remote server's SSH credentials<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks the SSH credentials on the remote server.</p>
<h3 id="authentication">Authentication</h3>
<p>There are several methods that you can use to authenticate a transfer session with the remote server.</p>
<h4 id="permitrootloginyes">PermitRootLogin=Yes</h4>
<p>The simplest authentication method is to use the <code>root</code> user and password. To do this, the <code>sshd_config</code> file on the remote server <strong>must</strong> contain the following value: <code>PermitRootLogin=Yes</code></p>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Value</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td><code>root</code></td>
</tr>
<tr>
<td><code>password</code></td>
<td><code>root</code>&#39;s password.</td>
</tr>
</tbody></table>
<p>You can also use the SSH Public Key to authenticate the <code>root</code> user. If the SSH Public Key is encrypted, include the SSH Key&#39;s passphrase.</p>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Value if the SSH Key is not encrypted</th>
<th>Value if the SSH Key is encrypted</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td><code>root</code></td>
<td><code>root</code></td>
</tr>
<tr>
<td><code>sshkey_name</code></td>
<td><code>root</code>&#39;s SSH key name.</td>
<td><code>root</code>&#39;s SSH key name.</td>
</tr>
<tr>
<td><code>sshkey_passphrase</code></td>
<td>(none)</td>
<td><code>root</code>&#39;s SSH key passphrase.</td>
</tr>
</tbody></table>
<h4 id="permitrootloginno">PermitRootLogin=No</h4>
<p>Many server administrators do not permit direct root logins on their servers.</p>
<ul>
<li>If the remote server contains <code>PermitRootLogin=No</code> in the <code>sshd_config </code>file, then you <strong>must</strong> use another user and their password on the remote server, and then escalate to <code>root</code>.</li>
<li>If the system administrator used WHM&#39;s <a href="https://go.cpanel.net/whmdocsManageWheelGroupUsers"><em>Manage Wheel Group Users</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Security Center &gt;&gt; Manage Wheel Group Users</em>) to grant the user <code>su</code> access, then you will need to specify <code>su</code> and the <code>root</code> password.</li>
<li>If the user has <code>sudo</code> access, you do <strong>not</strong> need the <code>root</code> password.</li>
</ul>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Value if the user has sudo access</th>
<th>Value if the user has su access</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td>The user&#39;s username.</td>
<td>The user&#39;s username.</td>
</tr>
<tr>
<td><code>password</code></td>
<td>The user&#39;s password.</td>
<td>The user&#39;s password.</td>
</tr>
<tr>
<td><code>root_escalation_method</code></td>
<td><code>sudo</code></td>
<td><code>su</code></td>
</tr>
<tr>
<td><code>root_password</code></td>
<td>(none)</td>
<td><code>root</code>&#39;s password.</td>
</tr>
</tbody></table>
<p>You can also use an SSH Public Key instead of a password to authenticate that user. If the SSH Public Key is encrypted, include the SSH Key&#39;s passphrase.</p>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>sudo</th>
<th>su</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td>The user&#39;s username.</td>
<td>The user&#39;s username.</td>
</tr>
<tr>
<td><code>sshkey_name</code></td>
<td>The user&#39;s SSH key name.</td>
<td>The user&#39;s SSH key name.</td>
</tr>
<tr>
<td><code>sshkey_passphrase</code> (If encrypted)</td>
<td>The user&#39;s SSH key passphrase.</td>
<td>The user&#39;s SSH key passphrase.</td>
</tr>
<tr>
<td><code>root_escalation_method</code></td>
<td><code>sudo</code></td>
<td><code>su</code></td>
</tr>
<tr>
<td><code>root_password</code></td>
<td>(none)</td>
<td><code>root</code>&#39;s password.</td>
</tr>
</tbody></table>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks the SSH credentials on the remote server.</p>
<h3 id="authentication">Authentication</h3>
<p>There are several methods that you can use to authenticate a transfer session with the remote server.</p>
<h4 id="permitrootloginyes">PermitRootLogin=Yes</h4>
<p>The simplest authentication method is to use the <code>root</code> user and password. To do this, the <code>sshd_config</code> file on the remote server <strong>must</strong> contain the following value: <code>PermitRootLogin=Yes</code></p>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Value</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td><code>root</code></td>
</tr>
<tr>
<td><code>password</code></td>
<td><code>root</code>'s password.</td>
</tr>
</tbody></table>
<p>You can also use the SSH Public Key to authenticate the <code>root</code> user. If the SSH Public Key is encrypted, include the SSH Key's passphrase.</p>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Value if the SSH Key is not encrypted</th>
<th>Value if the SSH Key is encrypted</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td><code>root</code></td>
<td><code>root</code></td>
</tr>
<tr>
<td><code>sshkey_name</code></td>
<td><code>root</code>'s SSH key name.</td>
<td><code>root</code>'s SSH key name.</td>
</tr>
<tr>
<td><code>sshkey_passphrase</code></td>
<td>(none)</td>
<td><code>root</code>'s SSH key passphrase.</td>
</tr>
</tbody></table>
<h4 id="permitrootloginno">PermitRootLogin=No</h4>
<p>Many server administrators do not permit direct root logins on their servers.</p>
<ul>
<li>If the remote server contains <code>PermitRootLogin=No</code> in the <code>sshd_config </code>file, then you <strong>must</strong> use another user and their password on the remote server, and then escalate to <code>root</code>.</li>
<li>If the system administrator used WHM's <a href="https://go.cpanel.net/whmdocsManageWheelGroupUsers"><em>Manage Wheel Group Users</em></a> interface (<em>WHM >> Home >> Security Center >> Manage Wheel Group Users</em>) to grant the user <code>su</code> access, then you will need to specify <code>su</code> and the <code>root</code> password.</li>
<li>If the user has <code>sudo</code> access, you do <strong>not</strong> need the <code>root</code> password.</li>
</ul>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Value if the user has sudo access</th>
<th>Value if the user has su access</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td>The user's username.</td>
<td>The user's username.</td>
</tr>
<tr>
<td><code>password</code></td>
<td>The user's password.</td>
<td>The user's password.</td>
</tr>
<tr>
<td><code>root_escalation_method</code></td>
<td><code>sudo</code></td>
<td><code>su</code></td>
</tr>
<tr>
<td><code>root_password</code></td>
<td>(none)</td>
<td><code>root</code>'s password.</td>
</tr>
</tbody></table>
<p>You can also use an SSH Public Key instead of a password to authenticate that user. If the SSH Public Key is encrypted, include the SSH Key's passphrase.</p>
<p>The following table displays the correct parameters and values for this authentication method:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>sudo</th>
<th>su</th>
</tr>
</thead>
<tbody><tr>
<td><code>user</code></td>
<td>The user's username.</td>
<td>The user's username.</td>
</tr>
<tr>
<td><code>sshkey_name</code></td>
<td>The user's SSH key name.</td>
<td>The user's SSH key name.</td>
</tr>
<tr>
<td><code>sshkey_passphrase</code> (If encrypted)</td>
<td>The user's SSH key passphrase.</td>
<td>The user's SSH key passphrase.</td>
</tr>
<tr>
<td><code>root_escalation_method</code></td>
<td><code>sudo</code></td>
<td><code>su</code></td>
</tr>
<tr>
<td><code>root_password</code></td>
<td>(none)</td>
<td><code>root</code>'s password.</td>
</tr>
</tbody></table>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></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</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">host=192.168.0.0</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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 username&#39;s password.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username'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">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 remote server&#39;s SSH port number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server's SSH port number.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="root_escalation_method" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">root_escalation_method</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"su"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"sudo"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">root_escalation_method=sudo</span></div><div><div html="<p>The escalation method to use to connect to the remote server.</p>
<ul>
<li><code>su</code></li>
<li><code>sudo</code></li>
</ul>
<p><strong>Note:</strong></p>
<p> Use this parameter if <code>PermitRootLogin=No</code> in the remote server&#39;s <code>sshd_config</code> file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The escalation method to use to connect to the remote server.</p>
<ul>
<li><code>su</code></li>
<li><code>sudo</code></li>
</ul>
<p><strong>Note:</strong></p>
<p> Use this parameter if <code>PermitRootLogin=No</code> in the remote server's <code>sshd_config</code> file.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="root_password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">root_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">root_password=123456luggage</span></div><div><div html="<p><code>root</code>&#39;s password on the remote server.</p>
<p><strong>Note:</strong></p>
<p> Use this parameter if <code>PermitRootLogin=No</code> in the remote server&#39;s <code>sshd_config</code> file and the <code>root_escalation_method</code> value is set to <code>su</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p><code>root</code>'s password on the remote server.</p>
<p><strong>Note:</strong></p>
<p> Use this parameter if <code>PermitRootLogin=No</code> in the remote server's <code>sshd_config</code> file and the <code>root_escalation_method</code> value is set to <code>su</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="sshkey_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">sshkey_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">sshkey_name=FrancisScott</span></div><div><div html="<p>The SSH key&#39;s name.</p>
<p><strong>Note:</strong></p>
<p> SSH keys are available in WHM&#39;s <em>Manage root&#39;s SSH Keys</em> interface (<em>WHM &gt;&gt; Home &gt;&gt; Security Center &gt;&gt; Manage root’s SSH Keys</em>).</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH key's name.</p>
<p><strong>Note:</strong></p>
<p> SSH keys are available in WHM's <em>Manage root's SSH Keys</em> interface (<em>WHM >> Home >> Security Center >> Manage root’s SSH Keys</em>).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="sshkey_passphrase" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">sshkey_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">sshkey_passphrase=kkwtoowoygidsa</span></div><div><div html="<p>The SSH key&#39;s passphrase.</p>
<p><strong>Note:</strong></p>
<p> Use this parameter if the SSH Key is encrypted.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH key's passphrase.</p>
<p><strong>Note:</strong></p>
<p> Use this parameter if the SSH Key is encrypted.</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=root</span></div><div><div html="<p>The username to use to connect to the remote server.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username to use to connect to the remote 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/remote_basic_credential_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/remote_basic_credential_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:R2a9lea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9lea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9lea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9lea:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9lea:0" aria-labelledby="tab:R2a9lea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
remote_basic_credential_check <span class="token punctuation">\</span>
<span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'192.168.0.0'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'root'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9lea:1" aria-labelledby="tab:R2a9lea: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:R2e9lea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9lea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9lea:0" aria-labelledby="tab:R2e9lea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"output"</span>: <span class="token string">"Basic credential check…\nDone\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response"</span>: <span class="token string">"basic credential check\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">"metadata"</span>: <button class="collapser" aria-label="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">"remote_basic_credential_check"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Success"</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/Transfer-Configuration/operation/validate_system_user" data-section-id="tag/Transfer-Configuration/operation/validate_system_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/validate_system_user" id="operation/validate_system_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Transfer-Configuration/operation/validate_system_user" aria-label="tag/Transfer-Configuration/operation/validate_system_user"></a>Validate username availability on target server<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function validates a system user for use on the target server.</p>
<p><strong>Note:</strong></p>
<p> For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function validates a system user for use on the target server.</p>
<p><strong>Note:</strong></p>
<p> For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</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="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 system username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The system 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/validate_system_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/validate_system_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:R2aalea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aalea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aalea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aalea:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aalea:0" aria-labelledby="tab:R2aalea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
validate_system_user <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R2aalea:1" aria-labelledby="tab:R2aalea: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:R2ealea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ealea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ealea:0" aria-labelledby="tab:R2ealea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"reserved"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"valid_for_new"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"valid_for_transfer"</span>: <span class="token number">1</span></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">"command"</span>: <span class="token string">"validate_system_user"</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/Transfer-Configuration/operation/delete_account_archives" data-section-id="tag/Transfer-Configuration/operation/delete_account_archives" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_account_archives" id="operation/delete_account_archives" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Transfer-Configuration/operation/delete_account_archives" aria-label="tag/Transfer-Configuration/operation/delete_account_archives"></a>Remove cPanel account's archives<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes a cPanel user account&#39;s archives.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a cPanel user account's archives.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="mountpoint" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mountpoint</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"/home"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mountpoint=/home/example/</span></div><div><div html="<p>The filepath to the archive storage location.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filepath to the archive storage location.</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=username</span></div><div><div html="<p>The cPanel account username.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel 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="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">/delete_account_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/delete_account_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:R2ablea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ablea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ablea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ablea:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ablea:0" aria-labelledby="tab:R2ablea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
delete_account_archives <span class="token punctuation">\</span>
<span class="token assign-left variable">user</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:R2ablea:1" aria-labelledby="tab:R2ablea: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:R2eblea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eblea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eblea:0" aria-labelledby="tab:R2eblea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"delete_account_archives"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"output"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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">"Found archive: /home/example/example.tar.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">"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">"This is a warning message."</span></div></li></ul><span class="token punctuation">]</span></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">"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/Transfer-Configuration/operation/transfer_module_schema" data-section-id="tag/Transfer-Configuration/operation/transfer_module_schema" class="sc-dntaoT ceciOs"><div data-section-id="operation/transfer_module_schema" id="operation/transfer_module_schema" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Transfer-Configuration/operation/transfer_module_schema" aria-label="tag/Transfer-Configuration/operation/transfer_module_schema"></a>Return a transfer module's schema<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves a transfer module&#39;s key structure.</p>
<p><strong>Note:</strong></p>
<p>For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a transfer module's key structure.</p>
<p><strong>Note:</strong></p>
<p>For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</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="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"AccountLocal"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"AccountRemoteRoot"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"AccountRemoteUser"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"FeaturesListRemoteRoot"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"LegacyAccountBackup"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"PackageRemoteRoot"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">module=AccountRemoteRoot</span></div><div><div html="<p>The transfer module&#39;s name.</p>
<ul>
<li><code>AccountLocal</code></li>
<li><code>AccountRemoteRoot</code></li>
<li><code>AccountRemoteUser</code></li>
<li><code>FeaturesListRemoteRoot</code></li>
<li><code>LegacyAccountBackup</code></li>
<li><code>PackageRemoteRoot</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The transfer module's name.</p>
<ul>
<li><code>AccountLocal</code></li>
<li><code>AccountRemoteRoot</code></li>
<li><code>AccountRemoteUser</code></li>
<li><code>FeaturesListRemoteRoot</code></li>
<li><code>LegacyAccountBackup</code></li>
<li><code>PackageRemoteRoot</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/transfer_module_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/transfer_module_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:R2aclea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aclea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aclea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aclea:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aclea:0" aria-labelledby="tab:R2aclea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
transfer_module_schema <span class="token punctuation">\</span>
<span class="token assign-left variable">module</span><span class="token operator">=</span><span class="token string">'AccountRemoteRoot'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aclea:1" aria-labelledby="tab:R2aclea: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:R2eclea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eclea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eclea:0" aria-labelledby="tab:R2eclea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"schema"</span>: <button class="collapser" aria-label="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">"copypoint"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"text"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpmovefile"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"text"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"customip"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"char(255) DEFAULT 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">"detected_remote_user"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"char(255) DEFAULT 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">"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">"def"</span>: <span class="token string">"text"</span></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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"char(255) DEFAULT 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">"files"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"BIGINT UNSIGNED DEFAULT 1"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"force"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"ip"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"live_transfer"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"localuser"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"char(255) DEFAULT 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">"mail_location"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"char(255) DEFAULT 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">"overwrite_all_dbs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"overwrite_all_dbusers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"overwrite_sameowner_dbs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"overwrite_sameowner_dbusers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"overwrite_with_delete"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"prerequisite_user"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"char(255) DEFAULT 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">"priority"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 255"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"replaceip"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"char(255) DEFAULT 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">"reseller"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"shared_mysql_server"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"size"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"BIGINT UNSIGNED DEFAULT 1"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"skipaccount"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"skipacctdb"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"skipbwdata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"skipemail"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"skiphomedir"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"skipres"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"skipsubdomains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"user"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"char(255) DEFAULT 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">"xferpoint"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"def"</span>: <span class="token string">"int(1) DEFAULT 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">"primary"</span>: <button class="collapser" aria-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"</span></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"</span>: <button class="collapser" aria-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"</span>,</div></li><li><div class="hoverable "><span class="token string">"localuser"</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">"metadata"</span>: <button class="collapser" aria-label="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">"transfer_module_schema"</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/Transfer-Monitoring" data-section-id="tag/Transfer-Monitoring" 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/Transfer-Monitoring" aria-label="tag/Transfer-Monitoring"></a>Transfer Monitoring</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Transfers / Transfer Monitoring</p>
"><p>Transfers / Transfer Monitoring</p>
</div></div></div><div id="tag/Transfer-Monitoring/operation/analyze_transfer_session_remote" data-section-id="tag/Transfer-Monitoring/operation/analyze_transfer_session_remote" class="sc-dntaoT ceciOs"><div data-section-id="operation/analyze_transfer_session_remote" id="operation/analyze_transfer_session_remote" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Transfer-Monitoring/operation/analyze_transfer_session_remote" aria-label="tag/Transfer-Monitoring/operation/analyze_transfer_session_remote"></a>Validate remote server's credentials<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks the remote server&#39;s credentials, which a transfer session uses to connect.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks the remote server's credentials, which a transfer session uses to connect.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="transfer_session_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">transfer_session_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">transfer_session_id=exampleservercopya20140206192428NtyW</span></div><div><div html="<p>The transfer session&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The transfer session'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="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">/analyze_transfer_session_remote</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/analyze_transfer_session_remote</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9nea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9nea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9nea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9nea:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9nea:0" aria-labelledby="tab:R2a9nea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
analyze_transfer_session_remote <span class="token punctuation">\</span>
<span class="token assign-left variable">transfer_session_id</span><span class="token operator">=</span><span class="token string">'exampleservercopya20140206192428NtyW'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9nea:1" aria-labelledby="tab:R2a9nea: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:R2e9nea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9nea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9nea:0" aria-labelledby="tab:R2e9nea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"analyze_transfer_session_remote"</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/Transfer-Monitoring/operation/available_transfer_modules" data-section-id="tag/Transfer-Monitoring/operation/available_transfer_modules" class="sc-dntaoT ceciOs"><div data-section-id="operation/available_transfer_modules" id="operation/available_transfer_modules" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Transfer-Monitoring/operation/available_transfer_modules" aria-label="tag/Transfer-Monitoring/operation/available_transfer_modules"></a>Return available transfer modules<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists all available transfer modules.</p>
<p><strong>Note:</strong></p>
<p> For more information about how this function works with other functions in the transfer and restore process, read our
<a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all available transfer modules.</p>
<p><strong>Note:</strong></p>
<p> For more information about how this function works with other functions in the transfer and restore process, read our
<a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/available_transfer_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/available_transfer_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:R2aanea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aanea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aanea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aanea:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aanea:0" aria-labelledby="tab:R2aanea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
available_transfer_modules
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aanea:1" aria-labelledby="tab:R2aanea: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:R2eanea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eanea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eanea:0" aria-labelledby="tab:R2eanea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"modules"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"AccountLocal"</span>: <span class="token string">"5000"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"AccountRemoteRoot"</span>: <span class="token string">"3000"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"AccountRemoteUser"</span>: <span class="token string">"4000"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FeatureListRemoteRoot"</span>: <span class="token string">"1000"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"LegacyAccountBackup"</span>: <span class="token string">"6000"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"PackageRemoteRoot"</span>: <span class="token string">"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">"metadata"</span>: <button class="collapser" aria-label="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">"available_transfer_modules"</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/Transfer-Monitoring/operation/fetch_transfer_session_log" data-section-id="tag/Transfer-Monitoring/operation/fetch_transfer_session_log" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_transfer_session_log" id="operation/fetch_transfer_session_log" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Transfer-Monitoring/operation/fetch_transfer_session_log" aria-label="tag/Transfer-Monitoring/operation/fetch_transfer_session_log"></a>Return transfer session's log file<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a transfer session&#39;s log file.</p>
<p><strong>Note:</strong></p>
<p> For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a transfer session's log file.</p>
<p><strong>Note:</strong></p>
<p> For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</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="logfile" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand logfile"><span class="property-name">logfile</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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">logfile=master.log</span></div><div><div html="<p>The log file&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The log file's name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="transfer_session_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">transfer_session_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">transfer_session_id=vm5docscpanelcopya20140224163412sylG</span></div><div><div html="<p>The transfer session&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The transfer session'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/fetch_transfer_session_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/fetch_transfer_session_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:R2abnea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abnea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abnea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abnea:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abnea:0" aria-labelledby="tab:R2abnea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
fetch_transfer_session_log <span class="token punctuation">\</span>
<span class="token assign-left variable">transfer_session_id</span><span class="token operator">=</span><span class="token string">'vm5docscpanelcopya20140224163412sylG'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">logfile</span><span class="token operator">=</span><span class="token string">'master.log'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abnea:1" aria-labelledby="tab:R2abnea: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:R2ebnea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebnea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebnea:0" aria-labelledby="tab:R2ebnea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"{\"contents\":{\"action\":\"start\",\"time\":1598991042,\"child_number\":0},\"pid\":12789,\"type\":\"control\",\"indent\":0,\"partial\":0}\n{\"partial\":0,\"indent\":0,\"type\":\"control\",\"pid\":12789,\"contents\":{\"time\":1598991042,\"action\":\"initiator\",\"child_number\":0,\"msg\":\"norootcopy\"}}\n{\"partial\":0,\"indent\":0,\"pid\":12789,\"type\":\"control\",\"contents\":{\"msg\":2.3,\"child_number\":0,\"time\":1598991042,\"action\":\"version\"}}\n{\"type\":\"control\",\"pid\":12789,\"contents\":{\"time\":1598991042,\"queue\":\"TRANSFER\",\"action\":\"queue_count\",\"msg\":1,\"child_number\":0},\"partial\":0,\"indent\":0}\n{\"contents\":{\"time\":1598991042,\"action\":\"queue_size\",\"queue\":\"TRANSFER\",\"child_number\":0,\"msg\":1},\"type\":\"control\",\"pid\":12789,\"indent\":0,\"partial\":0}\n{\"type\":\"control\",\"pid\":12789,\"contents\":{\"time\":1598991042,\"queue\":\"RESTORE\",\"action\":\"queue_count\",\"child_number\":0,\"msg\":1},\"partial\":0,\"indent\":0}\n{\"partial\":0,\"indent\":0,\"pid\":12789,\"type\":\"control\",\"contents\":{\"child_number\":0,\"msg\":1,\"time\":1598991042,\"action\":\"queue_size\",\"queue\":\"RESTORE\"}}\n{\"partial\":0,\"indent\":0,\"pid\":12789,\"type\":\"control\",\"contents\":{\"action\":\"remotehost\",\"time\":1598991042,\"msg\":\"10.1.32.200\",\"child_number\":0}}\n{\"partial\":0,\"indent\":0,\"type\":\"control\",\"pid\":12790,\"contents\":{\"item\":\"root\",\"time\":1598991042,\"child_number\":1,\"action\":\"start\",\"queue\":\"TRANSFER\",\"logfile\":\"item-TRANSFER_AccountRemoteUser_root\",\"local_item\":\"root\",\"item_name\":\"Account\",\"item_type\":\"AccountRemoteUser\"}}\n{\"indent\":0,\"partial\":0,\"contents\":{\"action\":\"process-item\",\"queue\":\"TRANSFER\",\"logfile\":\"item-TRANSFER_AccountRemoteUser_root\",\"item_type\":\"AccountRemoteUser\",\"item_name\":\"Account\",\"local_item\":\"root\",\"msg\":\"item-TRANSFER_AccountRemoteUser_root\",\"item\":\"root\",\"time\":1598991042,\"child_number\":1},\"pid\":12790,\"type\":\"control\"}\n{\"indent\":0,\"partial\":0,\"contents\":{\"logfile\":\"item-TRANSFER_AccountRemoteUser_root\",\"item_name\":\"Account\",\"item_type\":\"AccountRemoteUser\",\"local_item\":\"root\",\"msg\":{\"size\":1},\"queue\":\"TRANSFER\",\"action\":\"start-item\",\"child_number\":1,\"item\":\"root\",\"time\":1598991042},\"pid\":12790,\"type\":\"control\"}\n{\"contents\":{\"child_number\":1,\"item\":\"root\",\"time\":1598991042,\"logfile\":\"item-TRANSFER_AccountRemoteUser_root\",\"local_item\":\"root\",\"msg\":{\"dangerous_items\":0,\"skipped_items\":0,\"altered_items\":0,\"failure\":\"The account “root” already exists on “control.box.new”.\",\"size\":1,\"warnings\":0,\"contents\":{\"warnings\":null,\"skipped_items\":null,\"dangerous_items\":null,\"altered_items\":null}},\"item_name\":\"Account\",\"item_type\":\"AccountRemoteUser\",\"queue\":\"TRANSFER\",\"action\":\"failed-item\"},\"type\":\"control\",\"pid\":12790,\"indent\":0,\"partial\":0}\n{\"indent\":0,\"partial\":0,\"contents\":{\"item_type\":\"AccountRemoteUser\",\"item_name\":\"Account\",\"msg\":{\"size\":1},\"local_item\":\"root\",\"logfile\":\"item-RESTORE_AccountRemoteUser_root\",\"action\":\"start-item\",\"queue\":\"RESTORE\",\"child_number\":1,\"time\":1598991042,\"item\":\"root\"},\"type\":\"control\",\"pid\":12790}\n{\"pid\":12790,\"type\":\"control\",\"contents\":{\"item_type\":\"AccountRemoteUser\",\"item_name\":\"Account\",\"msg\":{\"size\":1,\"failure\":\"The account “root” already exists on “control.box.new”.\"},\"local_item\":\"root\",\"logfile\":\"item-RESTORE_AccountRemoteUser_root\",\"action\":\"failed-item\",\"queue\":\"RESTORE\",\"child_number\":1,\"time\":1598991042,\"item\":\"root\"},\"partial\":0,\"indent\":0}\n{\"contents\":{\"time\":1598991042,\"action\":\"complete\",\"queue\":\"TRANSFER\",\"child_number\":1},\"pid\":12790,\"type\":\"control\",\"indent\":0,\"partial\":0}\n{\"type\":\"control\",\"pid\":12791,\"contents\":{\"queue\":\"RESTORE\",\"action\":\"complete\",\"time\":1598991043,\"child_number\":1},\"partial\":0,\"indent\":0}\n{\"pid\":12789,\"type\":\"control\",\"contents\":{\"child_number\":0,\"action\":\"complete\",\"time\":1598991043},\"partial\":0,\"indent\":0}\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">"metadata"</span>: <button class="collapser" aria-label="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">"fetch_transfer_session_log"</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/Transfer-Monitoring/operation/get_transfer_session_state" data-section-id="tag/Transfer-Monitoring/operation/get_transfer_session_state" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_transfer_session_state" id="operation/get_transfer_session_state" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Transfer-Monitoring/operation/get_transfer_session_state" aria-label="tag/Transfer-Monitoring/operation/get_transfer_session_state"></a>Return transfer session's status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the state of a transfer session.</p>
<p><strong>Note:</strong></p>
<p>For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the state of a transfer session.</p>
<p><strong>Note:</strong></p>
<p>For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</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="transfer_session_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">transfer_session_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">transfer_session_id=exampleservercopya20140206192428NtyW</span></div><div><div html="<p>The transfer session&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The transfer session'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_transfer_session_state</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_transfer_session_state</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acnea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acnea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acnea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acnea:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acnea:0" aria-labelledby="tab:R2acnea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_transfer_session_state <span class="token punctuation">\</span>
<span class="token assign-left variable">transfer_session_id</span><span class="token operator">=</span><span class="token string">'exampleservercopya20140206192428NtyW'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acnea:1" aria-labelledby="tab:R2acnea: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:R2ecnea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecnea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecnea:0" aria-labelledby="tab:R2ecnea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"state_name"</span>: <span class="token string">"TRANSFER_INPROGRESS"</span></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">"command"</span>: <span class="token string">"get_transfer_session_state"</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/Transfer-Monitoring/operation/retrieve_transfer_session_remote_analysis" data-section-id="tag/Transfer-Monitoring/operation/retrieve_transfer_session_remote_analysis" class="sc-dntaoT ceciOs"><div data-section-id="operation/retrieve_transfer_session_remote_analysis" id="operation/retrieve_transfer_session_remote_analysis" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Transfer-Monitoring/operation/retrieve_transfer_session_remote_analysis" aria-label="tag/Transfer-Monitoring/operation/retrieve_transfer_session_remote_analysis"></a>Return transfer session's information<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function analyzes a transfer session.</p>
<p><strong>Note:</strong></p>
<p> For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</a> documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function analyzes a transfer session.</p>
<p><strong>Note:</strong></p>
<p> For more information about how this function works with other functions in the transfer and restore process, read our <a href="https://go.cpanel.net/transferrestoreAPIguide">Guide to Transfer and Restore API Functions</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="transfer_session_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">transfer_session_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">transfer_session_id=exampleservercopya20140206192428NtyW</span></div><div><div html="<p>The transfer session&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The transfer session'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/retrieve_transfer_session_remote_analysis</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/retrieve_transfer_session_remote_analysis</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adnea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adnea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adnea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adnea:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adnea:0" aria-labelledby="tab:R2adnea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
retrieve_transfer_session_remote_analysis <span class="token punctuation">\</span>
<span class="token assign-left variable">transfer_session_id</span><span class="token operator">=</span><span class="token string">'exampleservercopya20140206192428NtyW'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adnea:1" aria-labelledby="tab:R2adnea: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:R2ednea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ednea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ednea:0" aria-labelledby="tab:R2ednea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"config"</span>: <button class="collapser" aria-label="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_mysql_server"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</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="obj collapsible"><li><div class="hoverable "><span class="property token string">"accounts"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"packages"</span>: <span class="token punctuation">[ ]</span></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>: <button class="collapser" aria-label="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_ips"</span>: <button class="collapser" aria-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.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">"dbs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dbs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"MYSQL"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_db1"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</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">"user_db2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</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">"PGSQL"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_db1"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</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">"user_db2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">"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">"users"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"MYSQL"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_user1"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</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">"user_user2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</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">"PGSQL"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_user1"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</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">"user_user2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">"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></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dedicated_ips"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"192.168.1.2"</span>: <span class="token string">"domain.tld"</span></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="obj collapsible"><li><div class="hoverable "><span class="property token string">"*"</span>: <span class="token string">"nobody"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain.tld"</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">"groups"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"bin"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nobody"</span>: <span class="token number">1</span></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">"hostname.domain.tld"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"major_version"</span>: <span class="token string">"11.90"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"roundcube_dbtype"</span>: <span class="token string">"sqlite"</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="obj collapsible"><li><div class="hoverable "><span class="property token string">"nobody"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"root"</span>: <span class="token number">1</span></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">"11.90.0.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">"modules"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"Backups"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"analysis"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"Local Backups Version"</span>: <span class="token string">"11.90.0.6"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Remote Backups Version"</span>: <span class="token string">"11.88.0.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">"name"</span>: <span class="token string">"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">"MySQL"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"analysis"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"Local Type"</span>: <span class="token string">"MySQL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Local 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">"Remote Type"</span>: <span class="token string">"MariaDB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Remote Version"</span>: <span class="token string">"10.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">"name"</span>: <span class="token string">"Database 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">"options"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"skip_reseller_privs"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"unrestricted"</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">"remote"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"conflicts"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpversion"</span>: <span class="token string">"11.64"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dbs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dbs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"MYSQL"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_db1"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</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">"user_db2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</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">"PGSQL"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_db1"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</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">"user_db2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">"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">"users"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"MYSQL"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_user1"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</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">"user_user2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</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">"PGSQL"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_user1"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</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">"user_user2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">"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></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_disk_used"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_files_used"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_owners"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_package_extensions"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_xfertool"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host"</span>: <span class="token string">"192.168.1.1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hostname"</span>: <span class="token string">"hostname.domain.tld"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"linked_nodes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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 string">"mailnode"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled_services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"exim"</span>,</div></li><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">"hostname"</span>: <span class="token string">"remotemailnode.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_check"</span>: <span class="token number">1600126907</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"system_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">"Mail"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"globalspamassassin"</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">"tls_verified"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"root"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"11.90.0.6"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"worker_capabilities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"Mail"</span>: <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">"major_version"</span>: <span class="token string">"11.90"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"resellers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"resell2"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reseller"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"root"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"roundcube_dbtype"</span>: <span class="token string">"sqlite"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server_type"</span>: <span class="token string">"WHM1164"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"supports_live_transfers"</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">"11.90.0.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">"transfer_session_id"</span>: <span class="token string">"exampleservercopya20140206192428NtyW"</span></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">"command"</span>: <span class="token string">"retrieve_transfer_session_remote_analysis"</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/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/EasyApache-Settings/operation/ea4_get_currently_installed_packages" data-section-id="tag/EasyApache-Settings/operation/ea4_get_currently_installed_packages" class="sc-dntaoT ceciOs"><div data-section-id="operation/ea4_get_currently_installed_packages" id="operation/ea4_get_currently_installed_packages" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/EasyApache-Settings/operation/ea4_get_currently_installed_packages" aria-label="tag/EasyApache-Settings/operation/ea4_get_currently_installed_packages"></a>Return installed Easyapache 4 packages<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a list of the currently-installed EasyApache 4 packages.</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">Web Server role</a>, the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of the currently-installed EasyApache 4 packages.</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">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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ea4_get_currently_installed_packages</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ea4_get_currently_installed_packages</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9jeq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9jeq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9jeq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9jeq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9jeq:0" aria-labelledby="tab:R2a9jeq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
ea4_get_currently_installed_packages
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9jeq:1" aria-labelledby="tab:R2a9jeq: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:R2e9jeq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9jeq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9jeq:0" aria-labelledby="tab:R2e9jeq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><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="array collapsible"><li><div class="hoverable "><span class="token string">"ea-apache24"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"ea4_get_currently_installed_packages"</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/EasyApache-Settings/operation/ea4_metainfo" data-section-id="tag/EasyApache-Settings/operation/ea4_metainfo" class="sc-dntaoT ceciOs"><div data-section-id="operation/ea4_metainfo" id="operation/ea4_metainfo" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/EasyApache-Settings/operation/ea4_metainfo" aria-label="tag/EasyApache-Settings/operation/ea4_metainfo"></a>Return ea4-metainfo.json file contents<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the contents of the <code>/etc/cpanel/ea4/ea4-metainfo.json</code> file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the contents of the <code>/etc/cpanel/ea4/ea4-metainfo.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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><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>Contents of the <code>/etc/cpanel/ea4/ea4-metainfo.json</code> file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Contents of the <code>/etc/cpanel/ea4/ea4-metainfo.json</code> file.</p>
</div></div></div></td></tr><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">/ea4_metainfo</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ea4_metainfo</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aajeq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aajeq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aajeq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aajeq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aajeq:0" aria-labelledby="tab:R2aajeq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
ea4_metainfo
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aajeq:1" aria-labelledby="tab:R2aajeq: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:R2eajeq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eajeq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eajeq:0" aria-labelledby="tab:R2eajeq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"additional_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 string">"ea-nginx"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-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">"default_php_handler"</span>: <span class="token string">"cgi"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_php_package"</span>: <span class="token string">"ea-php72"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"object"</span></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">"command"</span>: <span class="token string">"ea4_metainfo"</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/EasyApache-Settings/operation/ea4_recommendations" data-section-id="tag/EasyApache-Settings/operation/ea4_recommendations" class="sc-dntaoT ceciOs"><div data-section-id="operation/ea4_recommendations" id="operation/ea4_recommendations" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/EasyApache-Settings/operation/ea4_recommendations" aria-label="tag/EasyApache-Settings/operation/ea4_recommendations"></a>Return EasyApache 4 recommendations<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns any recommendations attached to your installed
EasyApache 4 packages. For more information about the recommendation system,
read our <a href="https://go.cpanel.net/EasyApache4Recommendations">EasyApache 4 Recommendations</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 returns any recommendations attached to your installed
EasyApache 4 packages. For more information about the recommendation system,
read our <a href="https://go.cpanel.net/EasyApache4Recommendations">EasyApache 4 Recommendations</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ea4_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ea4_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:R2abjeq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abjeq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abjeq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abjeq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abjeq:0" aria-labelledby="tab:R2abjeq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
ea4_recommendations
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abjeq:1" aria-labelledby="tab:R2abjeq: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:R2ebjeq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebjeq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebjeq:0" aria-labelledby="tab:R2ebjeq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 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">"ruid2"</span>,</div></li><li><div class="hoverable "><span class="token string">"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">"metadata"</span>: <button class="collapser" aria-label="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">"ea4_recommendations"</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/EasyApache-Settings/operation/ea4_save_profile" data-section-id="tag/EasyApache-Settings/operation/ea4_save_profile" class="sc-dntaoT ceciOs"><div data-section-id="operation/ea4_save_profile" id="operation/ea4_save_profile" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/EasyApache-Settings/operation/ea4_save_profile" aria-label="tag/EasyApache-Settings/operation/ea4_save_profile"></a>Create EasyApache 4 profile<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates an EasyApache 4 profile. This function only writes files to the <code>/etc/cpanel/ea4/profiles/custom/</code> directory.</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 creates an EasyApache 4 profile. This function only writes files to the <code>/etc/cpanel/ea4/profiles/custom/</code> directory.</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="desc" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">desc</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">desc=This is my new profile.</span></div><div><div html="<p>The description of the profile.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The description of the profile.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="filename" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">filename</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">filename=new_profile.json</span></div><div><div html="<p>The profile&#39;s file name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The profile's file name.</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=New Profile</span></div><div><div html="<p>The profile&#39;s display name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The profile's display name.</p>
</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">overwrite=1</span></div><div><div html="<p>Whether to overwrite the file, if it exists.</p>
<ul>
<li><code>1</code> — Overwrite the file.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite the file.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to overwrite the file, if it exists.</p>
<ul>
<li><code>1</code> — Overwrite the file.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite the file.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="pkg" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">pkg</span><div class="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> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">pkg=ea-apache24&pkg=ea-apache24-foo</span></div><div><div html="<p>The packages that the profile contains.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The packages that the profile contains.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="tag" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">tag</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">""</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">tag=Apache 2.4&tag=Optimized for static content</span></div><div><div html="<p>Tags that are appropriate for the profile.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Tags that are appropriate for the profile.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="version" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">version</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"0"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">version=1.3</span></div><div><div html="<p>The profile&#39;s version number.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The profile's version 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ea4_save_profile</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ea4_save_profile</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acjeq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acjeq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acjeq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acjeq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acjeq:0" aria-labelledby="tab:R2acjeq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
ea4_save_profile <span class="token punctuation">\</span>
<span class="token assign-left variable">filename</span><span class="token operator">=</span><span class="token string">'new_profile.json'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'New Profile'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">pkg</span><span class="token operator">=</span><span class="token string">'ea-apache24'</span> <span class="token assign-left variable">pkg</span><span class="token operator">=</span><span class="token string">'ea-apache24-foo'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acjeq:1" aria-labelledby="tab:R2acjeq: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:R2ecjeq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecjeq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecjeq:0" aria-labelledby="tab:R2ecjeq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"already_exists"</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">"/etc/cpanel/ea4/profiles/custom/new_profile.json"</span></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">"command"</span>: <span class="token string">"ea4_save_profile"</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/EasyApache-Settings/operation/ea4_get_additional_pkg_prefixes" data-section-id="tag/EasyApache-Settings/operation/ea4_get_additional_pkg_prefixes" class="sc-dntaoT ceciOs"><div data-section-id="operation/ea4_get_additional_pkg_prefixes" id="operation/ea4_get_additional_pkg_prefixes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/EasyApache-Settings/operation/ea4_get_additional_pkg_prefixes" aria-label="tag/EasyApache-Settings/operation/ea4_get_additional_pkg_prefixes"></a>Return any additional package prefixes, beyond `ea`.<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns any additional package prefixes set up in the <code>/etc/cpanel/ea4/additional-pkg-prefixes/</code> file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns any additional package prefixes set up in the <code>/etc/cpanel/ea4/additional-pkg-prefixes/</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ea4_get_additional_pkg_prefixes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ea4_get_additional_pkg_prefixes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adjeq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adjeq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adjeq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adjeq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adjeq:0" aria-labelledby="tab:R2adjeq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty ea4_get_additional_pkg_prefixes
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adjeq:1" aria-labelledby="tab:R2adjeq: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:R2edjeq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edjeq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edjeq:0" aria-labelledby="tab:R2edjeq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"additional_pkg_prefixes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"altea"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"ea4_get_additional_pkg_prefixes"</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/EasyApache-Settings/operation/ea4_list_profiles" data-section-id="tag/EasyApache-Settings/operation/ea4_list_profiles" class="sc-dntaoT ceciOs"><div data-section-id="operation/ea4_list_profiles" id="operation/ea4_list_profiles" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/EasyApache-Settings/operation/ea4_list_profiles" aria-label="tag/EasyApache-Settings/operation/ea4_list_profiles"></a>Return EasyApache 4 profiles<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns a list of all <a href="https://docs.cpanel.net/ea4/">EasyApache 4</a> profiles and the packages that each profile provides.</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">Web Server</a> role, the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of all <a href="https://docs.cpanel.net/ea4/">EasyApache 4</a> profiles and the packages that each profile provides.</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">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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/ea4_list_profiles</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/ea4_list_profiles</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aejeq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aejeq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aejeq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aejeq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aejeq:0" aria-labelledby="tab:R2aejeq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
ea4_list_profiles
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aejeq:1" aria-labelledby="tab:R2aejeq: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:R2eejeq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eejeq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eejeq:0" aria-labelledby="tab:R2eejeq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cpanel"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"desc"</span>: <span class="token string">"The currently installed packages on the server."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"No PHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pkgs"</span>: <button class="collapser" aria-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"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php74"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"ea-apache24"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php74"</span></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_data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"not_on_server"</span>: <button class="collapser" aria-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"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php74"</span></div></li></ul><span class="token punctuation">]</span></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">"1.2"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"custom"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"The currently installed packages on the server."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"No PHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"default.json"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pkgs"</span>: <button class="collapser" aria-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"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php74"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"Apache 2.4"</span>,</div></li><li><div class="hoverable "><span class="token string">"PHP 7.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">"validation_data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"not_on_server"</span>: <button class="collapser" aria-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"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php74"</span></div></li></ul><span class="token punctuation">]</span></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">"1.2"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"The currently installed packages on the server."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"No PHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"default.json"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pkgs"</span>: <button class="collapser" aria-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"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php74"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"ea-apache24"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php74"</span></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_data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"not_on_server"</span>: <button class="collapser" aria-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"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php74"</span></div></li></ul><span class="token punctuation">]</span></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">"1.2"</span></div></li></ul><span class="token punctuation">}</span></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="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"The currently installed packages on the server."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"No PHP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">"default.json"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pkgs"</span>: <button class="collapser" aria-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"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php74"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"ea-apache24"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php74"</span></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_data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"not_on_server"</span>: <button class="collapser" aria-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"</span>,</div></li><li><div class="hoverable "><span class="token string">"ea-php74"</span></div></li></ul><span class="token punctuation">]</span></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">"1.2"</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">"metadata"</span>: <button class="collapser" aria-label="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">"ea4_list_profiles"</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/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>The PHP module for WHM API 1.</p>
"><p>The PHP module for WHM API 1.</p>
</div></div></div><div id="tag/PHP/operation/php_get_handlers" data-section-id="tag/PHP/operation/php_get_handlers" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_get_handlers" id="operation/php_get_handlers" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP/operation/php_get_handlers" aria-label="tag/PHP/operation/php_get_handlers"></a>Return PHP handlers<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the PHP handlers on the system.</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">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 handlers on the system.</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">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="version" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">version</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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>An installed PHP version.</p>
<ul>
<li><code>ea-php54</code></li>
<li><code>ea-php55</code></li>
<li><code>ea-php56</code></li>
<li><code>ea-php70</code></li>
<li><code>ea-php71</code></li>
<li><code>ea-php72</code></li>
<li><code>inherit</code></li>
<li>Any custom PHP package name.</li>
</ul>
<p><strong>Important:</strong></p>
<p>We deprecated PHP 5.6 and PHP 7.0 and will remove them in a future version.
For more information, read our
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-deprecation-plan/">cPanel Deprecation Plan</a>
documentation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An installed PHP version.</p>
<ul>
<li><code>ea-php54</code></li>
<li><code>ea-php55</code></li>
<li><code>ea-php56</code></li>
<li><code>ea-php70</code></li>
<li><code>ea-php71</code></li>
<li><code>ea-php72</code></li>
<li><code>inherit</code></li>
<li>Any custom PHP package name.</li>
</ul>
<p><strong>Important:</strong></p>
<p>We deprecated PHP 5.6 and PHP 7.0 and will remove them in a future version.
For more information, read our
<a href="https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-deprecation-plan/">cPanel Deprecation Plan</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/php_get_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_get_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:R4khleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4khleq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4khleq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4khleq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4khleq:0" aria-labelledby="tab:R4khleq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_get_handlers
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4khleq:1" aria-labelledby="tab:R4khleq: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:R4shleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4shleq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4shleq:0" aria-labelledby="tab:R4shleq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_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 "><button class="collapser" aria-label="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_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 string">"cgi"</span>,</div></li><li><div class="hoverable "><span class="token string">"none"</span>,</div></li><li><div class="hoverable "><span class="token string">"suphp"</span></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_handler"</span>: <span class="token string">"suphp"</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></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">"metadata"</span>: <button class="collapser" aria-label="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">"php_get_handlers"</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/PHP/operation/php_get_impacted_domains" data-section-id="tag/PHP/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/operation/php_get_impacted_domains" aria-label="tag/PHP/operation/php_get_impacted_domains"></a>Return PHP preconfigured domains<!-- --> </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>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">Web Server 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>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">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></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> -<!-- --> <!-- -->Pass multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> -<!-- --> <!-- -->Pass a single domain.</li></ul><div><div html="<p>A domain on the system.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>must</strong> 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 <strong>must</strong> 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><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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>
<ul>
<li>You <strong>must</strong> pass either the <code>system_default</code> or <code>domain</code> parameters, or both.</li>
<li>If you pass this parameter with a false value and do <strong>not</strong> also pass the <code>domain</code>
parameter, the function returns an error.</li>
</ul>
" 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>
<ul>
<li>You <strong>must</strong> pass either the <code>system_default</code> or <code>domain</code> parameters, or both.</li>
<li>If you pass this parameter with a false value and do <strong>not</strong> also pass the <code>domain</code>
parameter, the function returns an error.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R4kileq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kileq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kileq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kileq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kileq:0" aria-labelledby="tab:R4kileq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_get_impacted_domains <span class="token punctuation">\</span>
<span class="token assign-left variable">system_default</span><span class="token operator">=</span><span class="token string">'1'</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:R4kileq:1" aria-labelledby="tab:R4kileq: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:R4sileq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sileq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sileq:0" aria-labelledby="tab:R4sileq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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><li><div class="hoverable "><span class="token string">"subdomain.example.com"</span>,</div></li><li><div class="hoverable "><span class="token string">"example2.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">"metadata"</span>: <button class="collapser" aria-label="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">"php_get_impacted_domains"</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/PHP/operation/php_ini_set_content" data-section-id="tag/PHP/operation/php_ini_set_content" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_ini_set_content" id="operation/php_ini_set_content" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP/operation/php_ini_set_content" aria-label="tag/PHP/operation/php_ini_set_content"></a>Update PHP version's php.ini file<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function changes the contents of a PHP version&#39;s php.ini file.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>This document <strong>only</strong> applies to systems that run EasyApache 4.</li>
<li>Due to the limited field length of HTTP GET method calls, we <strong>strongly</strong> recommend that you use the HTTP POST method.</li>
</ul>
<p><strong>Important:</strong>
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 changes the contents of a PHP version's php.ini file.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>This document <strong>only</strong> applies to systems that run EasyApache 4.</li>
<li>Due to the limited field length of HTTP GET method calls, we <strong>strongly</strong> recommend that you use the HTTP POST method.</li>
</ul>
<p><strong>Important:</strong>
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="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=[PHP]
; About php.ini
; php.ini is responsible for configuring many of the aspects of PHP's behavior.
pcre.backtrack_limit=100000
</span></div><div><div html="<p>The contents of the <code>php.ini</code> file that you wish to change.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The contents of the <code>php.ini</code> file that you wish to change.</p>
</div></div></div></td></tr><tr class="last "><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-php74</span></div><div><div html="<p>The version of PHP for which you wish to change the <code>php.ini</code> file.</p>
<ul>
<li><code>ea-php72</code></li>
<li><code>ea-php73</code></li>
<li><code>ea-php74</code></li>
<li><code>Any custom PHP package name</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of PHP for which you wish to change the <code>php.ini</code> file.</p>
<ul>
<li><code>ea-php72</code></li>
<li><code>ea-php73</code></li>
<li><code>ea-php74</code></li>
<li><code>Any custom PHP package name</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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/php_ini_set_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_ini_set_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:R4kjleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kjleq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kjleq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjleq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kjleq:0" aria-labelledby="tab:R4kjleq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_ini_set_content <span class="token punctuation">\</span>
<span class="token assign-left variable">content</span><span class="token operator">=</span><span class="token string">$'[PHP]
; About php.ini
; php.ini is responsible for configuring many of the aspects of PHP\'s behavior.
pcre.backtrack_limit=100000
'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">version</span><span class="token operator">=</span><span class="token string">'ea-php74'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjleq:1" aria-labelledby="tab:R4kjleq: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:R4sjleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sjleq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sjleq:0" aria-labelledby="tab:R4sjleq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"php_ini_set_content"</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/PHP/operation/php_ini_get_content" data-section-id="tag/PHP/operation/php_ini_get_content" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_ini_get_content" id="operation/php_ini_get_content" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP/operation/php_ini_get_content" aria-label="tag/PHP/operation/php_ini_get_content"></a>Return PHP version's php.ini file<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the contents of a PHP version&#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.</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 returns the contents of a PHP version'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.</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="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-php74</span></div><div><div html="<p>The name of an installed PHP version&#39;s package.</p>
<ul>
<li><code>ea-php##</code>, where <code>##</code> represents the major and minor versions of PHP (for example, <code>ea-php74</code> represents PHP 7.4).</li>
<li><code>inherit</code></li>
<li>Any custom PHP package name.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of an installed PHP version's package.</p>
<ul>
<li><code>ea-php##</code>, where <code>##</code> represents the major and minor versions of PHP (for example, <code>ea-php74</code> represents PHP 7.4).</li>
<li><code>inherit</code></li>
<li>Any custom PHP package name.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/php_ini_get_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_ini_get_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:R4kkleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kkleq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kkleq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kkleq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kkleq:0" aria-labelledby="tab:R4kkleq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_ini_get_content <span class="token punctuation">\</span>
<span class="token assign-left variable">version</span><span class="token operator">=</span><span class="token string">'ea-php74'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kkleq:1" aria-labelledby="tab:R4kkleq: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:R4skleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4skleq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4skleq:0" aria-labelledby="tab:R4skleq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"display_errors; Default Value: On; Development Value: On; Production Value: Off;"</span></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">"command"</span>: <span class="token string">"php_ini_get_content"</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/PHP/operation/php_set_system_default_version" data-section-id="tag/PHP/operation/php_set_system_default_version" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_set_system_default_version" id="operation/php_set_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/operation/php_set_system_default_version" aria-label="tag/PHP/operation/php_set_system_default_version"></a>Update default PHP version<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>The version of PHP that you wish to set as the system&#39;s default.</p>
<ul>
<li><code>ea-php81</code></li>
<li><code>inherit</code></li>
<li>Any custom PHP package name.</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>The version of PHP that you wish to set as the system's default.</p>
<ul>
<li><code>ea-php81</code></li>
<li><code>inherit</code></li>
<li>Any custom PHP package name.</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><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><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-php81</span></div><div><div html="<p>The version of PHP that you wish to set as the system&#39;s default.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of PHP that you wish to set as the system's default.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/php_set_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_set_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:R4klleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4klleq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4klleq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4klleq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4klleq:0" aria-labelledby="tab:R4klleq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_set_system_default_version <span class="token punctuation">\</span>
<span class="token assign-left variable">version</span><span class="token operator">=</span><span class="token string">'ea-php74'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4klleq:1" aria-labelledby="tab:R4klleq: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:R4slleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4slleq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4slleq:0" aria-labelledby="tab:R4slleq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"php_set_system_default_version"</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/PHP/operation/php_get_vhost_versions" data-section-id="tag/PHP/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/operation/php_get_vhost_versions" aria-label="tag/PHP/operation/php_get_vhost_versions"></a>Return PHP version of all virtual hosts<!-- --> </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><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><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><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R4kmleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kmleq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kmleq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmleq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kmleq:0" aria-labelledby="tab:R4kmleq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_get_vhost_versions
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmleq:1" aria-labelledby="tab:R4kmleq: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:R4smleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4smleq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4smleq:0" aria-labelledby="tab:R4smleq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 "><button class="collapser" aria-label="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">"rm3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"account_owner"</span>: <span class="token string">"root"</span><span class="token punctuation">,</span></div></li><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">"homedir"</span>: <span class="token string">"/home/rm3"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_suspended"</span>: <span class="token number">0</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">"example.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">"otherchars.rm3.tld"</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">"metadata"</span>: <button class="collapser" aria-label="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">"php_get_vhost_versions"</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/PHP/operation/php_set_session_save_path" data-section-id="tag/PHP/operation/php_set_session_save_path" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_set_session_save_path" id="operation/php_set_session_save_path" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP/operation/php_set_session_save_path" aria-label="tag/PHP/operation/php_set_session_save_path"></a>Update PHP default save path<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the location of PHP&#39;s default session save path.</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">Web Server role</a>, the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the location of PHP's default session save path.</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">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="overwrite" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">overwrite</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">overwrite=0</span></div><div><div html="<p>Whether to overwrite the existing session save path in the <code>php.ini</code>
file.</p>
<ul>
<li><code>1</code> — Overwrite the existing value in the <code>php.ini</code> file.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite the existing value in the <code>php.ini</code> file.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to overwrite the existing session save path in the <code>php.ini</code>
file.</p>
<ul>
<li><code>1</code> — Overwrite the existing value in the <code>php.ini</code> file.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite the existing value in the <code>php.ini</code> file.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">"/var/cpanel/php/sessions"</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">path=/var/cpanel/php/sessions</span></div><div><div html="<p>The directory in which to save session information.</p>
<p><strong>Warning:</strong></p>
<p>For security reasons, do <strong>not</strong> set this value to <code>/tmp</code> or another insecure location.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory in which to save session information.</p>
<p><strong>Warning:</strong></p>
<p>For security reasons, do <strong>not</strong> set this value to <code>/tmp</code> or another insecure location.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><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">/php_set_session_save_path</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_set_session_save_path</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4knleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4knleq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4knleq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knleq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4knleq:0" aria-labelledby="tab:R4knleq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_set_session_save_path
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knleq:1" aria-labelledby="tab:R4knleq: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:R4snleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4snleq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4snleq:0" aria-labelledby="tab:R4snleq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"php_set_session_save_path"</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/PHP/operation/php_get_installed_versions" data-section-id="tag/PHP/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/operation/php_get_installed_versions" aria-label="tag/PHP/operation/php_get_installed_versions"></a>Return installed PHP versions<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the installed PHP versions on a server.</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://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#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 installed PHP versions on a server.</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://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R4koleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4koleq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4koleq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4koleq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4koleq:0" aria-labelledby="tab:R4koleq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_get_installed_versions
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4koleq:1" aria-labelledby="tab:R4koleq: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:R4soleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4soleq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4soleq:0" aria-labelledby="tab:R4soleq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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-php74"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</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">"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/PHP/operation/php_set_vhost_versions" data-section-id="tag/PHP/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/operation/php_set_vhost_versions" aria-label="tag/PHP/operation/php_set_vhost_versions"></a>Update domain's PHP values<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function allows WHM&#39;s
<a href="https://docs.cpanel.net/whm/software/multiphp-manager-for-whm/"><em>MultiPHP Manager</em></a>
interface (<em>WHM &gt;&gt; Home &gt;&gt; Software &gt;&gt; MultiPHP Manager</em>) to change the values of a domain.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server has at
least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM
on a server with <strong>less</strong> than the required RAM, your server may experience severe
performance issues.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function allows WHM's
<a href="https://docs.cpanel.net/whm/software/multiphp-manager-for-whm/"><em>MultiPHP Manager</em></a>
interface (<em>WHM >> Home >> Software >> MultiPHP Manager</em>) to change the values of a domain.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server has at
least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM
on a server with <strong>less</strong> than the required RAM, your server may experience severe
performance issues.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="php_fpm" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">php_fpm</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">php_fpm=1</span></div><div><div html="<p>Whether PHP-FPM is enabled.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether PHP-FPM is enabled.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="php_fpm_pool_parms" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand php_fpm_pool_parms"><span class="property-name">php_fpm_pool_parms</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> <!-- --><<!-- -->json<!-- -->><!-- --> </span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">php_fpm_pool_parms={"pm_max_children":5,"pm_max_requests":20,"pm_process_idle_timeout":10}</span></div><div><div html="<p>A JSON-encoded string containing a hash of values.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A JSON-encoded string containing a hash of values.</p>
</div></div></div></td></tr><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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ea-php54"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ea-php55"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ea-php56"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ea-php70"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ea-php71"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"ea-php72"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"inherit"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">version=ea-php70</span></div><div><div html="<p>The virtual host&#39;s (vhost) PHP version.</p>
<p><strong>Note:</strong></p>
<p>This parameter also accepts any custom PHP package names.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The virtual host's (vhost) PHP version.</p>
<p><strong>Note:</strong></p>
<p>This parameter also accepts any custom PHP package names.</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></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=otherchars.rm3.tld vhost-2=morechars.rm3.tld vhost-3=lotschars.rm3.tld</span> -<!-- --> <!-- -->Set multiple vhosts.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">vhost=otherchars.rm3.tld</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 set multiple vhosts, 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 set multiple vhosts, 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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R4kpleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kpleq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kpleq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kpleq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kpleq:0" aria-labelledby="tab:R4kpleq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <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-php70'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">vhost</span><span class="token operator">=</span><span class="token string">'otherchars.rm3.tld'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kpleq:1" aria-labelledby="tab:R4kpleq: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:R4spleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4spleq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4spleq:0" aria-labelledby="tab:R4spleq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"php_set_vhost_versions"</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/PHP/operation/php_get_system_default_version" data-section-id="tag/PHP/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/operation/php_get_system_default_version" aria-label="tag/PHP/operation/php_get_system_default_version"></a>Return system default PHP version<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the system default 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/serverroles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the system default 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/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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/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:R4kqleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kqleq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kqleq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqleq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kqleq:0" aria-labelledby="tab:R4kqleq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_get_system_default_version
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqleq:1" aria-labelledby="tab:R4kqleq: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:R4sqleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sqleq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sqleq:0" aria-labelledby="tab:R4sqleq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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-php56"</span></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">"command"</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">"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/PHP/operation/php_ini_set_directives" data-section-id="tag/PHP/operation/php_ini_set_directives" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_ini_set_directives" id="operation/php_ini_set_directives" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP/operation/php_ini_set_directives" aria-label="tag/PHP/operation/php_ini_set_directives"></a>Update PHP version's directives<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the value of a PHP version&#39;s directives.</p>
<p><strong>Note:</strong></p>
<p> This document only applies to systems that run EasyApache 4.</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 sets the value of a PHP version's directives.</p>
<p><strong>Note:</strong></p>
<p> This document only applies to systems that run EasyApache 4.</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="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:0&directive-2=max_input_vars=1000</span> -<!-- --> <!-- -->Set the values for multiple directives.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">directive=allow_url_fopen:0</span> -<!-- --> <!-- -->Set the value for a single directive.</li></ul><div><div html="<p>The name of a PHP directive and its value.</p>
<p><strong>Note:</strong></p>
<p> To change the directive&#39;s value for multiple PHP directives, duplicate or increment the parameter name. For example, to change three directives, use the directive parameter multiple times or use the <code>directive-1</code>, <code>directive-2</code> , and <code>directive-3</code> parameters.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of a PHP directive and its value.</p>
<p><strong>Note:</strong></p>
<p> To change the directive's value for multiple PHP directives, duplicate or increment the parameter name. For example, to change three directives, use the directive parameter multiple times or use the <code>directive-1</code>, <code>directive-2</code> , and <code>directive-3</code> parameters.</p>
</div></div></div></td></tr><tr class="last "><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>PHP version on the system.</p>
<p><strong>Note</strong></p>
<ul>
<li><code>ea-php56</code></li>
<li><code>ea-php70</code></li>
<li><code>ea-php71</code></li>
<li><code>ea-php72</code></li>
<li>Any custom PHP package name.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>PHP version on the system.</p>
<p><strong>Note</strong></p>
<ul>
<li><code>ea-php56</code></li>
<li><code>ea-php70</code></li>
<li><code>ea-php71</code></li>
<li><code>ea-php72</code></li>
<li>Any custom PHP package name.</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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/php_ini_set_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_ini_set_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:R4krleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4krleq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4krleq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4krleq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4krleq:0" aria-labelledby="tab:R4krleq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_ini_set_directives <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> <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>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4krleq:1" aria-labelledby="tab:R4krleq: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:R4srleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4srleq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4srleq:0" aria-labelledby="tab:R4srleq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"php_ini_set_directives"</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/PHP/operation/php_ini_get_directives" data-section-id="tag/PHP/operation/php_ini_get_directives" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_ini_get_directives" id="operation/php_ini_get_directives" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP/operation/php_ini_get_directives" aria-label="tag/PHP/operation/php_ini_get_directives"></a>Return PHP version's directives<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the directives in the selected PHP version&#39;s php.ini file. WHM&#39;s <a href="https://go.cpanel.net/WHMMultiPHPINI"><em>MultiPHP INI Editor</em></a> interface (<em>Home &gt;&gt; Software &gt;&gt; MultiPHP INI Editor</em>) lists these directives in the <em>Basic Mode</em> section.</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">Web Server role</a>, the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the directives in the selected PHP version's php.ini file. WHM's <a href="https://go.cpanel.net/WHMMultiPHPINI"><em>MultiPHP INI Editor</em></a> interface (<em>Home >> Software >> MultiPHP INI Editor</em>) lists these directives in the <em>Basic Mode</em> section.</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">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="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-php74</span></div><div><div html="<p>The name of an installed version of PHP.</p>
<ul>
<li><code>ea-php72</code></li>
<li><code>ea-php73</code></li>
<li><code>ea-php74</code></li>
<li>Any custom PHP package name</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of an installed version of PHP.</p>
<ul>
<li><code>ea-php72</code></li>
<li><code>ea-php73</code></li>
<li><code>ea-php74</code></li>
<li>Any custom PHP package name</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/php_ini_get_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_ini_get_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:R4ksleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4ksleq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4ksleq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4ksleq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4ksleq:0" aria-labelledby="tab:R4ksleq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_ini_get_directives <span class="token punctuation">\</span>
<span class="token assign-left variable">version</span><span class="token operator">=</span><span class="token string">'ea-php74'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4ksleq:1" aria-labelledby="tab:R4ksleq: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:R4ssleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4ssleq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4ssleq:0" aria-labelledby="tab:R4ssleq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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 string">"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">"boolean"</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">"metadata"</span>: <button class="collapser" aria-label="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">"php_ini_get_directives"</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/PHP/operation/php_set_handler" data-section-id="tag/PHP/operation/php_set_handler" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_set_handler" id="operation/php_set_handler" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP/operation/php_set_handler" aria-label="tag/PHP/operation/php_set_handler"></a>Update PHP version's handler<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets a PHP version&#39;s handler.</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">Web Server role</a>, the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets a PHP version's handler.</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">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="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"> <!-- -->Possible Values<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"cgi"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"suphp"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"dso"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">"none"</span> </div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">handler=suphp</span></div><div><div html="<p>An installed PHP handler.</p>
<ul>
<li><code>cgi</code></li>
<li><code>suphp</code></li>
<li><code>dso</code></li>
<li><code>none</code></li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An installed PHP handler.</p>
<ul>
<li><code>cgi</code></li>
<li><code>suphp</code></li>
<li><code>dso</code></li>
<li><code>none</code></li>
</ul>
</div></div></div></td></tr><tr class="last "><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-php70</span></div><div><div html="<p>An installed PHP version.</p>
<ul>
<li><code>ea-php54</code></li>
<li><code>ea-php55</code></li>
<li><code>ea-php56</code></li>
<li><code>ea-php70</code></li>
<li><code>ea-php71</code></li>
<li><code>ea-php72</code></li>
<li><code>inherit</code></li>
<li>Any custom PHP package name.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An installed PHP version.</p>
<ul>
<li><code>ea-php54</code></li>
<li><code>ea-php55</code></li>
<li><code>ea-php56</code></li>
<li><code>ea-php70</code></li>
<li><code>ea-php71</code></li>
<li><code>ea-php72</code></li>
<li><code>inherit</code></li>
<li>Any custom PHP package name.</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="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">/php_set_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_set_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:R4ktleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4ktleq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4ktleq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4ktleq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4ktleq:0" aria-labelledby="tab:R4ktleq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_set_handler <span class="token punctuation">\</span>
<span class="token assign-left variable">version</span><span class="token operator">=</span><span class="token string">'ea-php70'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">handler</span><span class="token operator">=</span><span class="token string">'suphp'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4ktleq:1" aria-labelledby="tab:R4ktleq: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:R4stleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4stleq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4stleq:0" aria-labelledby="tab:R4stleq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"php_set_handler"</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/PHP/operation/php_get_vhosts_by_version" data-section-id="tag/PHP/operation/php_get_vhosts_by_version" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_get_vhosts_by_version" id="operation/php_get_vhosts_by_version" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP/operation/php_get_vhosts_by_version" aria-label="tag/PHP/operation/php_get_vhosts_by_version"></a>Return virtual hosts per PHP version<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the virtual hosts that use a specified version of PHP.</p>
<p><strong>Note:</strong></p>
<p>This document only applies to systems that run EasyApache 4.</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 virtual hosts that use a specified version of PHP.</p>
<p><strong>Note:</strong></p>
<p>This document only applies to systems that run EasyApache 4.</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="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-php56</span></div><div><div html="<p>The name of an installed PHP package.</p>
<ul>
<li><code>ea-php##</code>, where <code>##</code> represents the major and minor versions of PHP (for example, <code>ea-php72</code> represents PHP 7.2).</li>
<li><code>inherit</code></li>
<li>Any custom PHP package name.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of an installed PHP package.</p>
<ul>
<li><code>ea-php##</code>, where <code>##</code> represents the major and minor versions of PHP (for example, <code>ea-php72</code> represents PHP 7.2).</li>
<li><code>inherit</code></li>
<li>Any custom PHP package name.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/php_get_vhosts_by_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_get_vhosts_by_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:R4kuleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kuleq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kuleq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kuleq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kuleq:0" aria-labelledby="tab:R4kuleq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_get_vhosts_by_version <span class="token punctuation">\</span>
<span class="token assign-left variable">version</span><span class="token operator">=</span><span class="token string">'ea-php56'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kuleq:1" aria-labelledby="tab:R4kuleq: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:R4suleq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4suleq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4suleq:0" aria-labelledby="tab:R4suleq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">"metadata"</span>: <button class="collapser" aria-label="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">"php_get_vhosts_by_version"</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/PHP-FPM" data-section-id="tag/PHP-FPM" 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-FPM" aria-label="tag/PHP-FPM"></a>PHP-FPM</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Web Server Configuration / PHP-FPM</p>
"><p>Web Server Configuration / PHP-FPM</p>
</div></div></div><div id="tag/PHP-FPM/operation/convert_all_domains_to_fpm" data-section-id="tag/PHP-FPM/operation/convert_all_domains_to_fpm" class="sc-dntaoT ceciOs"><div data-section-id="operation/convert_all_domains_to_fpm" id="operation/convert_all_domains_to_fpm" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-FPM/operation/convert_all_domains_to_fpm" aria-label="tag/PHP-FPM/operation/convert_all_domains_to_fpm"></a>Enable PHP-FPM on all domains<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function activates PHP-FPM for any non-PHP-FPM domains on a server.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles"><em>Web Server</em></a> role, the system <strong>disables</strong> this function.</p>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function activates PHP-FPM for any non-PHP-FPM domains on a server.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles"><em>Web Server</em></a> role, the system <strong>disables</strong> this function.</p>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/convert_all_domains_to_fpm</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/convert_all_domains_to_fpm</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4khneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4khneq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4khneq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4khneq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4khneq:0" aria-labelledby="tab:R4khneq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
convert_all_domains_to_fpm
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4khneq:1" aria-labelledby="tab:R4khneq: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:R4shneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4shneq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4shneq:0" aria-labelledby="tab:R4shneq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"build_id"</span>: <span class="token number">1493645268</span></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">"command"</span>: <span class="token string">"convert_all_domains_to_fpm"</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/PHP-FPM/operation/php_fpm_config_set" data-section-id="tag/PHP-FPM/operation/php_fpm_config_set" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_fpm_config_set" id="operation/php_fpm_config_set" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-FPM/operation/php_fpm_config_set" aria-label="tag/PHP-FPM/operation/php_fpm_config_set"></a>Update PHP-FPM directives and pool options<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function configures the PHP INI directives and pool options
for a system&#39;s or domain&#39;s PHP-FPM configuration.</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>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or
at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may
experience severe performance issues.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function configures the PHP INI directives and pool options
for a system's or domain's PHP-FPM configuration.</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>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or
at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may
experience severe performance issues.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></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=""><td kind="field" title="config" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand config"><span class="property-name">config</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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">objects</span></div> <div><div html="<p>An array of objects containing the PHP-FPM configuration values to validate or update.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An array of objects containing the PHP-FPM configuration values to validate or update.</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></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><div html="<p>A blank value or domain name whose PHP-FPM configuration you wish
to set.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A blank value or domain name whose PHP-FPM configuration you wish
to set.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="validate_only" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">validate_only</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">boolean</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">false</span></div> <div><div html="<p>Whether the function request is for validation or to update the settings.</p>
<ul>
<li><code>true</code> - Only validate the configuration.</li>
<li><code>false</code> - Validate and update the configuration.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the function request is for validation or to update the settings.</p>
<ul>
<li><code>true</code> - Only validate the configuration.</li>
<li><code>false</code> - Validate and update the configuration.</li>
</ul>
</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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/php_fpm_config_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_fpm_config_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:R4kineq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kineq:0" tabindex="0" data-rttab="true">Payload</li><li class="react-tabs__tab" role="tab" id="tab:R4kineq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kineq:1" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kineq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kineq: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:R4kineq:0" aria-labelledby="tab:R4kineq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"config"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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_flag_name"</span>: <span class="token string">"error_reporting"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trinary_admin_value"</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">"E_ALL & ~E_NOTICE"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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_flag_name"</span>: <span class="token string">"pm_max_children"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trinary_admin_value"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"10"</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:R4kineq:1" aria-labelledby="tab:R4kineq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kineq:2" aria-labelledby="tab:R4kineq: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:R4sineq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sineq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sineq:0" aria-labelledby="tab:R4sineq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"php_fpm_config_set"</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/PHP-FPM/operation/is_conversion_in_progress" data-section-id="tag/PHP-FPM/operation/is_conversion_in_progress" class="sc-dntaoT ceciOs"><div data-section-id="operation/is_conversion_in_progress" id="operation/is_conversion_in_progress" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-FPM/operation/is_conversion_in_progress" aria-label="tag/PHP-FPM/operation/is_conversion_in_progress"></a>Return PHP-FPM conversion status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function indicates whether the system&#39;s process to convert all of WHM&#39;s accounts to use PHP-FPM is in progress.</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>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function indicates whether the system's process to convert all of WHM's accounts to use PHP-FPM is in progress.</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>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/is_conversion_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/is_conversion_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:R4kjneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kjneq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kjneq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjneq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kjneq:0" aria-labelledby="tab:R4kjneq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
is_conversion_in_progress
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjneq:1" aria-labelledby="tab:R4kjneq: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:R4sjneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sjneq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sjneq:0" aria-labelledby="tab:R4sjneq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"inProgress"</span>: <span class="token number">1</span></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">"command"</span>: <span class="token string">"is_conversion_in_progress"</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/PHP-FPM/operation/php_get_old_fpm_flag" data-section-id="tag/PHP-FPM/operation/php_get_old_fpm_flag" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_get_old_fpm_flag" id="operation/php_get_old_fpm_flag" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-FPM/operation/php_get_old_fpm_flag" aria-label="tag/PHP-FPM/operation/php_get_old_fpm_flag"></a>Return PHP-FPM preconfigured status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function determines whether your system runs with a preconfigured PHP-FPM configuration.</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">Web Server role</a>, the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function determines whether your system runs with a preconfigured PHP-FPM configuration.</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">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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/php_get_old_fpm_flag</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_get_old_fpm_flag</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kkneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kkneq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kkneq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kkneq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kkneq:0" aria-labelledby="tab:R4kkneq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_get_old_fpm_flag
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kkneq:1" aria-labelledby="tab:R4kkneq: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:R4skneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4skneq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4skneq:0" aria-labelledby="tab:R4skneq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"old_fpm_flag"</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">"metadata"</span>: <button class="collapser" aria-label="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">"php_get_old_fpm_flag"</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/PHP-FPM/operation/php_set_default_accounts_to_fpm" data-section-id="tag/PHP-FPM/operation/php_set_default_accounts_to_fpm" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_set_default_accounts_to_fpm" id="operation/php_set_default_accounts_to_fpm" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-FPM/operation/php_set_default_accounts_to_fpm" aria-label="tag/PHP-FPM/operation/php_set_default_accounts_to_fpm"></a>Enable PHP-FPM on new cPanel accounts and domains<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function determines whether to enable PHP-FPM on new accounts and domains on a server.</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">Web Server role</a>, the system <strong>disables</strong> this function.</p>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function determines whether to enable PHP-FPM on new accounts and domains on a server.</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">Web Server role</a>, the system <strong>disables</strong> this function.</p>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="default_accounts_to_fpm" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">default_accounts_to_fpm</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">default_accounts_to_fpm=1</span></div><div><div html="<p>Whether to enable PHP-FPM on all new accounts and domains on
a server.</p>
<ul>
<li><code>1</code> — Enable PHP-FPM.</li>
<li><code>0</code> — Disable PHP-FPM.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable PHP-FPM on all new accounts and domains on
a server.</p>
<ul>
<li><code>1</code> — Enable PHP-FPM.</li>
<li><code>0</code> — Disable PHP-FPM.</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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><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="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">/php_set_default_accounts_to_fpm</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_set_default_accounts_to_fpm</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4klneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4klneq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4klneq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4klneq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4klneq:0" aria-labelledby="tab:R4klneq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_set_default_accounts_to_fpm <span class="token punctuation">\</span>
<span class="token assign-left variable">default_accounts_to_fpm</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:R4klneq:1" aria-labelledby="tab:R4klneq: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:R4slneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4slneq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4slneq:0" aria-labelledby="tab:R4slneq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"php_set_default_accounts_to_fpm"</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/PHP-FPM/operation/php_set_old_fpm_flag" data-section-id="tag/PHP-FPM/operation/php_set_old_fpm_flag" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_set_old_fpm_flag" id="operation/php_set_old_fpm_flag" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-FPM/operation/php_set_old_fpm_flag" aria-label="tag/PHP-FPM/operation/php_set_old_fpm_flag"></a>Enable PHP-FPM preconfigured status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function creates the <code>/etc/cpanel/ea4/old_fpm_flag</code> touch file.</p>
<p><strong>Note:</strong></p>
<p>If this touch file exists, the system will <strong>not</strong> display a message that indicates whether your system runs on an outdated PHP-FPM configuration. If you wish to see the message again, delete this touch file.</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">Web Server role</a>, the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates the <code>/etc/cpanel/ea4/old_fpm_flag</code> touch file.</p>
<p><strong>Note:</strong></p>
<p>If this touch file exists, the system will <strong>not</strong> display a message that indicates whether your system runs on an outdated PHP-FPM configuration. If you wish to see the message again, delete this touch file.</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">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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/php_set_old_fpm_flag</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_set_old_fpm_flag</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kmneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kmneq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kmneq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmneq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kmneq:0" aria-labelledby="tab:R4kmneq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_set_old_fpm_flag
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmneq:1" aria-labelledby="tab:R4kmneq: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:R4smneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4smneq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4smneq:0" aria-labelledby="tab:R4smneq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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">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">"metadata"</span>: <button class="collapser" aria-label="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">"php_set_old_fpm_flag"</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/PHP-FPM/operation/get_fpm_count_and_utilization" data-section-id="tag/PHP-FPM/operation/get_fpm_count_and_utilization" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_fpm_count_and_utilization" id="operation/get_fpm_count_and_utilization" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-FPM/operation/get_fpm_count_and_utilization" aria-label="tag/PHP-FPM/operation/get_fpm_count_and_utilization"></a>Return workload data for PHP-FPM on all domains<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function provides information that will help you to determine
whether your server can handle the workload if you enable PHP-FPM for all domains.</p>
<p><strong>Important:</strong></p>
<p>When you disable the
<a href="https://go.cpanel.net/howtouseserverprofiles">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server
has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable
PHP-FPM on a server with less than the required RAM, your server may experience severe
performance issues.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function provides information that will help you to determine
whether your server can handle the workload if you enable PHP-FPM for all domains.</p>
<p><strong>Important:</strong></p>
<p>When you disable the
<a href="https://go.cpanel.net/howtouseserverprofiles">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server
has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable
PHP-FPM on a server with less than the required RAM, your server may experience severe
performance issues.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/get_fpm_count_and_utilization</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/get_fpm_count_and_utilization</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4knneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4knneq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4knneq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knneq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4knneq:0" aria-labelledby="tab:R4knneq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
get_fpm_count_and_utilization
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knneq:1" aria-labelledby="tab:R4knneq: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:R4snneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4snneq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4snneq:0" aria-labelledby="tab:R4snneq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_to_be_enabled"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains_using_fpm"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"memory_needed"</span>: <span class="token number">90000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"number_of_new_fpm_accounts_we_can_handle"</span>: <span class="token number">8</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"show_warning"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total_domains"</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">"metadata"</span>: <button class="collapser" aria-label="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">"get_fpm_count_and_utilization"</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/PHP-FPM/operation/php_fpm_config_get" data-section-id="tag/PHP-FPM/operation/php_fpm_config_get" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_fpm_config_get" id="operation/php_fpm_config_get" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-FPM/operation/php_fpm_config_get" aria-label="tag/PHP-FPM/operation/php_fpm_config_get"></a>Return PHP-FPM directives and pool options<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the PHP INI directives and pool options for a system&#39;s or domain&#39;s PHP-FPM configuration.</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>
<p> <strong>Warning:</strong></p>
<p> We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the PHP INI directives and pool options for a system's or domain's PHP-FPM configuration.</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>
<p> <strong>Warning:</strong></p>
<p> We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></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="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"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">""</span></div> <div><div html="<p>A blank value or domain name whose PHP-FPM configuration you wish to retrieve.</p>
<ul>
<li>A valid domain that resides on the local server — Retrieves the domain&#39;s PHP-FPM configuration information.</li>
<li>A blank value — Retrieves the system&#39;s PHP-FPM information.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A blank value or domain name whose PHP-FPM configuration you wish to retrieve.</p>
<ul>
<li>A valid domain that resides on the local server — Retrieves the domain's PHP-FPM configuration information.</li>
<li>A blank value — Retrieves the system's PHP-FPM information.</li>
</ul>
</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/php_fpm_config_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_fpm_config_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:R4koneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4koneq:0" tabindex="0" data-rttab="true">Payload</li><li class="react-tabs__tab" role="tab" id="tab:R4koneq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4koneq:1" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4koneq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4koneq: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:R4koneq:0" aria-labelledby="tab:R4koneq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4koneq:1" aria-labelledby="tab:R4koneq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4koneq:2" aria-labelledby="tab:R4koneq: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:R4soneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4soneq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4soneq:0" aria-labelledby="tab:R4soneq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"config"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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_flag_name"</span>: <span class="token string">"short_open_tag"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trinary_admin_value"</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">"on"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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_flag_name"</span>: <span class="token string">"log_errors"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trinary_admin_value"</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">"on"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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_flag_name"</span>: <span class="token string">"pm_process_idle_timeout"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trinary_admin_value"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"10"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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_flag_name"</span>: <span class="token string">"error_reporting"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trinary_admin_value"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"E_ALL & ~E_NOTICE"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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_flag_name"</span>: <span class="token string">"disable_functions"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trinary_admin_value"</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">"exec,passthru,shell_exec,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">"base_flag_name"</span>: <span class="token string">"error_log"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trinary_admin_value"</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">"[% homedir %]/logs/[% scrubbed_domain %].php.error.log"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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_flag_name"</span>: <span class="token string">"pm_max_children"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trinary_admin_value"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"5"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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_flag_name"</span>: <span class="token string">"pm_max_requests"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trinary_admin_value"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"20"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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_flag_name"</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">"trinary_admin_value"</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">"on"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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_flag_name"</span>: <span class="token string">"doc_root"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trinary_admin_value"</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">"[% documentroot %]"</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">"metadata"</span>: <button class="collapser" aria-label="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">"php_fpm_config_get"</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/PHP-FPM/operation/php_get_default_accounts_to_fpm" data-section-id="tag/PHP-FPM/operation/php_get_default_accounts_to_fpm" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_get_default_accounts_to_fpm" id="operation/php_get_default_accounts_to_fpm" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-FPM/operation/php_get_default_accounts_to_fpm" aria-label="tag/PHP-FPM/operation/php_get_default_accounts_to_fpm"></a>Return PHP-FPM status on new accounts<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function determines whether the system enables PHP-FPM for new domains and accounts.</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>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server has at
least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM
on a server with less than the required RAM, your server may experience severe performance
issues.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function determines whether the system enables PHP-FPM for new domains and accounts.</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>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you only activate Apache PHP-FPM if your server has at
least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM
on a server with less than the required RAM, your server may experience severe performance
issues.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/php_get_default_accounts_to_fpm</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/php_get_default_accounts_to_fpm</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kpneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kpneq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kpneq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kpneq:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kpneq:0" aria-labelledby="tab:R4kpneq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
php_get_default_accounts_to_fpm
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kpneq:1" aria-labelledby="tab:R4kpneq: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:R4spneq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4spneq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4spneq:0" aria-labelledby="tab:R4spneq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_accounts_to_fpm"</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">"metadata"</span>: <button class="collapser" aria-label="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">"php_get_default_accounts_to_fpm"</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/Rule-Settings" data-section-id="tag/Rule-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/Rule-Settings" aria-label="tag/Rule-Settings"></a>Rule Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Web Server Security (ModSecurity) / Rule Settings</p>
"><p>Web Server Security (ModSecurity) / Rule Settings</p>
</div></div></div><div id="tag/Rule-Settings/operation/modsec_add_rule" data-section-id="tag/Rule-Settings/operation/modsec_add_rule" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_add_rule" id="operation/modsec_add_rule" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Settings/operation/modsec_add_rule" aria-label="tag/Rule-Settings/operation/modsec_add_rule"></a>Add staged ModSecurity rule<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds a new rule to a ModSecurity™ configuration staging file. For example, if you choose to add a rule for the example.conf file, the function stages the rule in the example.conf. STAGE file.</p>
<p><strong>Important:</strong></p>
<p> This function does not actually deploy the rule. To deploy the rule, use the WHM API 1 Functions - modsec_deploy_all_rule_changes function.</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 adds a new rule to a ModSecurity™ configuration staging file. For example, if you choose to add a rule for the example.conf file, the function stages the rule in the example.conf. STAGE file.</p>
<p><strong>Important:</strong></p>
<p> This function does not actually deploy the rule. To deploy the rule, use the WHM API 1 Functions - modsec_deploy_all_rule_changes function.</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=""><td kind="field" title="config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">config</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">config=modsec2.user.conf</span></div><div><div html="<p>The ModSecurity configuration file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity configuration file.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="rule" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">rule</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rule=SecAction "phase:1,id:168,nolog,pass,setvar:tx.REMOTE_ADDR=/%{REMOTE_ADDR}/"</span></div><div><div html="<p>The rule&#39;s text.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The rule'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_add_rule</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_add_rule</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4khjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4khjfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4khjfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4khjfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4khjfa:0" aria-labelledby="tab:R4khjfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_add_rule <span class="token punctuation">\</span>
<span class="token assign-left variable">config</span><span class="token operator">=</span><span class="token string">'modsec2.user.conf'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">rule</span><span class="token operator">=</span><span class="token string">'SecAction "phase:1,id:168,nolog,pass,setvar:tx.REMOTE_ADDR=/%{REMOTE_ADDR}/"'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4khjfa:1" aria-labelledby="tab:R4khjfa: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:R4shjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4shjfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4shjfa:0" aria-labelledby="tab:R4shjfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"rule"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"config"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"config_active"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"duplicate"</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 number">168</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_msg"</span>: <span class="token string">"Example rule message"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rule"</span>: <span class="token string">"SecAction \\\"phase:1,id:168,nolog,pass,setvar:tx.REMOTE_ADDR=/%{REMOTE_ADDR}/\\\""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"staged"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_active"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_id"</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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_add_rule"</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/Rule-Settings/operation/modsec_check_rule" data-section-id="tag/Rule-Settings/operation/modsec_check_rule" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_check_rule" id="operation/modsec_check_rule" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Settings/operation/modsec_check_rule" aria-label="tag/Rule-Settings/operation/modsec_check_rule"></a>Validate ModSecurity rule<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks a ModSecurity™ rule&#39;s validity.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks a ModSecurity™ rule's validity.</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">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="rule" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">rule</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rule=SecAction "pass,id:1234567"</span></div><div><div html="<p>The ModSecurity rule to check.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity rule to check.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_check_rule</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_check_rule</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kijfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kijfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kijfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kijfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kijfa:0" aria-labelledby="tab:R4kijfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_check_rule <span class="token punctuation">\</span>
<span class="token assign-left variable">rule</span><span class="token operator">=</span><span class="token string">'SecAction "pass,id:1234567"'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kijfa:1" aria-labelledby="tab:R4kijfa: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:R4sijfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sijfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sijfa:0" aria-labelledby="tab:R4sijfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"problem"</span>: <span class="token string">"The rule is invalid. Apache returned the following error: AH00526: Syntax error on line 1 of /var/tmp/15500._USR_LOCAL_CPANEL_WHOSTMGR_BIN_XML_API__.gl2t8wZ1.tmp/validate.conf:\nInvalid command ''OWASP'', perhaps misspelled or defined by a module not included in the server configuration\n'"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"valid"</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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_check_rule"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"OK Invalid Rule"</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/Rule-Settings/operation/modsec_clone_rule" data-section-id="tag/Rule-Settings/operation/modsec_clone_rule" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_clone_rule" id="operation/modsec_clone_rule" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Settings/operation/modsec_clone_rule" aria-label="tag/Rule-Settings/operation/modsec_clone_rule"></a>Save ModSecurity rule copy<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function copies a ModSecurity™ rule with a new rule ID.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function copies a ModSecurity™ rule with a new rule ID.</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">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="config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">config</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">config=modsec2.user.conf</span></div><div><div html="<p>The rule&#39;s ModSecurity configuration file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The rule's ModSecurity configuration file.</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">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">id=123456789</span></div><div><div html="<p>The existing rule&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The existing rule'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_clone_rule</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_clone_rule</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kjjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kjjfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kjjfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjjfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kjjfa:0" aria-labelledby="tab:R4kjjfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_clone_rule <span class="token punctuation">\</span>
<span class="token assign-left variable">config</span><span class="token operator">=</span><span class="token string">'modsec2.user.conf'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'123456789'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjjfa:1" aria-labelledby="tab:R4kjjfa: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:R4sjjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sjjfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sjjfa:0" aria-labelledby="tab:R4sjjfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"rule"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"config"</span>: <span class="token string">"modsec2.user.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"config_active"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disabled"</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 number">123456789</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_msg"</span>: <span class="token string">"Rejected request"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rule"</span>: <span class="token string">"SecRule REQUEST_URI \"/rejected.php\" \"deny,auditlog,msg:'Rejected request',id:'1'\""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"staged"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_active"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_id"</span>: <span class="token string">"YourVendor"</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"modsec_clone_rule"</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/Rule-Settings/operation/modsec_deploy_all_rule_changes" data-section-id="tag/Rule-Settings/operation/modsec_deploy_all_rule_changes" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_deploy_all_rule_changes" id="operation/modsec_deploy_all_rule_changes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Settings/operation/modsec_deploy_all_rule_changes" aria-label="tag/Rule-Settings/operation/modsec_deploy_all_rule_changes"></a>Enable all staged ModSecurity rule changes<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deploys the staged changes for all of the ModSecurity™ configuration files
into the live configuration files. After the function deploys the configuration files, it
restarts Apache. If the new configuration is invalid, the system restores the original
configuration and preserves the staged changes.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deploys the staged changes for all of the ModSecurity™ configuration files
into the live configuration files. After the function deploys the configuration files, it
restarts Apache. If the new configuration is invalid, the system restores the original
configuration and preserves the staged changes.</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">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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_deploy_all_rule_changes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_deploy_all_rule_changes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kkjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kkjfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kkjfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kkjfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kkjfa:0" aria-labelledby="tab:R4kkjfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_deploy_all_rule_changes
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kkjfa:1" aria-labelledby="tab:R4kkjfa: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:R4skjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4skjfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4skjfa:0" aria-labelledby="tab:R4skjfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"modsec_vendor_configs/MyVendor/one.conf"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"outcomes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"config"</span>: <span class="token string">"modsec_vendor_configs/MyVendor/one.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exception"</span>: <span class="token string">"The system could not deploy changes for modsec_vendor_configs/MyVendor/one.conf: The system could not validate the new Apache configuration, because httpd exited with a nonzero value. Apache produced the following error: httpd: Syntax error on line 37 of /usr/local/apache/conf/httpd.conf: Syntax error on line 26 of /usr/local/apache/conf/modsec2.conf: Syntax error on line 27 of /usr/local/apache/conf/modsec2.cpanel.conf: Could not open configuration file /usr/local/apache/conf/modsec_vendor_configs/MyVendor/one.conf: No such file or directory\n\n\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ok"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_deploy_all_rule_changes"</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/Rule-Settings/operation/modsec_deploy_rule_changes" data-section-id="tag/Rule-Settings/operation/modsec_deploy_rule_changes" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_deploy_rule_changes" id="operation/modsec_deploy_rule_changes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Settings/operation/modsec_deploy_rule_changes" aria-label="tag/Rule-Settings/operation/modsec_deploy_rule_changes"></a>Enable staged ModSecurity rule changes<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deploys staged changes to the ModSecurity™ configuration file and restarts
Apache.</p>
<p><strong>Note:</strong></p>
<p>If the new configuration is invalid, the system will restore the original configuration
and maintain the staged changes.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deploys staged changes to the ModSecurity™ configuration file and restarts
Apache.</p>
<p><strong>Note:</strong></p>
<p>If the new configuration is invalid, the system will restore the original configuration
and maintain the staged changes.</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">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="config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">config</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">config=modsec_vendor_configs/example.conf</span></div><div><div html="<p>The ModSecurity configuration file&#39;s path and name, relative to the <code>/usr/local/apache/conf/</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity configuration file's path and name, relative to the <code>/usr/local/apache/conf/</code> 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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_deploy_rule_changes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_deploy_rule_changes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kljfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kljfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kljfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kljfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kljfa:0" aria-labelledby="tab:R4kljfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_deploy_rule_changes <span class="token punctuation">\</span>
<span class="token assign-left variable">config</span><span class="token operator">=</span><span class="token string">'modsec_vendor_configs/example.conf'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kljfa:1" aria-labelledby="tab:R4kljfa: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:R4sljfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sljfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sljfa:0" aria-labelledby="tab:R4sljfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_deploy_rule_changes"</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/Rule-Settings/operation/modsec_discard_all_rule_changes" data-section-id="tag/Rule-Settings/operation/modsec_discard_all_rule_changes" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_discard_all_rule_changes" id="operation/modsec_discard_all_rule_changes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Settings/operation/modsec_discard_all_rule_changes" aria-label="tag/Rule-Settings/operation/modsec_discard_all_rule_changes"></a>Remove all staged ModSecurity rule changes<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function discards the staged ModSecurity™ rule changes, if present, for all of
the configuration files.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function discards the staged ModSecurity™ rule changes, if present, for all of
the configuration files.</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">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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_discard_all_rule_changes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_discard_all_rule_changes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kmjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kmjfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kmjfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmjfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kmjfa:0" aria-labelledby="tab:R4kmjfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_discard_all_rule_changes
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmjfa:1" aria-labelledby="tab:R4kmjfa: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:R4smjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4smjfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4smjfa:0" aria-labelledby="tab:R4smjfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"modsec_vendor_configs/MyVendor/one.conf"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"outcomes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"config"</span>: <span class="token string">"modsec_vendor_configs/MyVendor/one.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exception"</span>: <span class="token string">"The system could not remove the file /usr/local/apache/conf/modsec_vendor_configs/MyVendor/one.conf.STAGE: Invalid argument\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ok"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_discard_all_rule_changes"</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/Rule-Settings/operation/modsec_disable_rule" data-section-id="tag/Rule-Settings/operation/modsec_disable_rule" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_disable_rule" id="operation/modsec_disable_rule" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Settings/operation/modsec_disable_rule" aria-label="tag/Rule-Settings/operation/modsec_disable_rule"></a>Disable ModSecurity rule<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function disables a ModSecurity™ rule.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables a ModSecurity™ rule.</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">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="config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">config</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">config=modsec_vendor_configs/example.conf</span></div><div><div html="<p>The ModSecurity configuration file, relative to the <code>/etc/apache2/conf.d</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity configuration file, relative to the <code>/etc/apache2/conf.d</code> directory.</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=1234567890</span></div><div><div html="<p>The ModSecurity rule&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity rule'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="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">/modsec_disable_rule</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_disable_rule</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4knjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4knjfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4knjfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knjfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4knjfa:0" aria-labelledby="tab:R4knjfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_disable_rule <span class="token punctuation">\</span>
<span class="token assign-left variable">config</span><span class="token operator">=</span><span class="token string">'modsec_vendor_configs/example.conf'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'1234567890'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knjfa:1" aria-labelledby="tab:R4knjfa: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:R4snjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4snjfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4snjfa:0" aria-labelledby="tab:R4snjfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"modsec_disable_rule"</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/Rule-Settings/operation/modsec_discard_rule_changes" data-section-id="tag/Rule-Settings/operation/modsec_discard_rule_changes" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_discard_rule_changes" id="operation/modsec_discard_rule_changes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Settings/operation/modsec_discard_rule_changes" aria-label="tag/Rule-Settings/operation/modsec_discard_rule_changes"></a>Remove staged ModSecurity rule changes<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function discards staged rule changes for a ModSecurity™ configuration file.
Staged rule changes reside in a <code>.STAGE</code> file (for example, the staged changes for
the <code>example.conf</code> file exist in the <code>example.conf.STAGE</code> file).
This function deletes the <code>.STAGE</code> file that corresponds to the configuration file that
you specify.</p>
<p><strong>Note:</strong></p>
<p>To stage rule changes, call WHM API 1&#39;s <code>modsec_add_rule</code> function.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function discards staged rule changes for a ModSecurity™ configuration file.
Staged rule changes reside in a <code>.STAGE</code> file (for example, the staged changes for
the <code>example.conf</code> file exist in the <code>example.conf.STAGE</code> file).
This function deletes the <code>.STAGE</code> file that corresponds to the configuration file that
you specify.</p>
<p><strong>Note:</strong></p>
<p>To stage rule changes, call WHM API 1's <code>modsec_add_rule</code> function.</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">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="config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">config</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">config=modsec2.example.conf</span></div><div><div html="<p>The ModSecurity configuration file in the <code>/usr/local/cpanel/apache/conf/</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity configuration file in the <code>/usr/local/cpanel/apache/conf/</code> 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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_discard_rule_changes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_discard_rule_changes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kojfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kojfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kojfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kojfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kojfa:0" aria-labelledby="tab:R4kojfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_discard_rule_changes <span class="token punctuation">\</span>
<span class="token assign-left variable">config</span><span class="token operator">=</span><span class="token string">'modsec2.example.conf'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kojfa:1" aria-labelledby="tab:R4kojfa: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:R4sojfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sojfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sojfa:0" aria-labelledby="tab:R4sojfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_discard_rule_changes"</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/Rule-Settings/operation/modsec_edit_rule" data-section-id="tag/Rule-Settings/operation/modsec_edit_rule" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_edit_rule" id="operation/modsec_edit_rule" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Settings/operation/modsec_edit_rule" aria-label="tag/Rule-Settings/operation/modsec_edit_rule"></a>Update staged ModSecurity rule<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function stages edits to a ModSecurity™ rule. The system does <strong>not</strong> save changes
directly to the configuration file. Instead, it stages the changes to the configuration
file&#39;s <code>.STAGE</code> file (for example, for the <code>example.conf</code> file, the system stages changes
in the <code>example.conf.STAGE</code> file).</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function stages edits to a ModSecurity™ rule. The system does <strong>not</strong> save changes
directly to the configuration file. Instead, it stages the changes to the configuration
file's <code>.STAGE</code> file (for example, for the <code>example.conf</code> file, the system stages changes
in the <code>example.conf.STAGE</code> file).</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">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="config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">config</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">config=modsec_vendor_configs/example.conf</span></div><div><div html="<p>The ModSecurity configuration file, relative to the <code>/usr/local/apache/conf/</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity configuration file, relative to the <code>/usr/local/apache/conf/</code> directory.</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">integer</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=1234567</span></div><div><div html="<p>The ModSecurity rule&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity rule's ID.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="rule" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">rule</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rule=SecAction "pass,id:1234567"</span></div><div><div html="<p>The new ModSecurity rule.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new ModSecurity rule.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_edit_rule</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_edit_rule</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kpjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kpjfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kpjfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kpjfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kpjfa:0" aria-labelledby="tab:R4kpjfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_edit_rule <span class="token punctuation">\</span>
<span class="token assign-left variable">config</span><span class="token operator">=</span><span class="token string">'modsec_vendor_configs/example.conf'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'1234567'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">rule</span><span class="token operator">=</span><span class="token string">'SecAction "pass,id:1234567"'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kpjfa:1" aria-labelledby="tab:R4kpjfa: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:R4spjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4spjfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4spjfa:0" aria-labelledby="tab:R4spjfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"rule"</span>: <button class="collapser" aria-label="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>: <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 number">1234567</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_msg"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rule"</span>: <span class="token string">"SecAction \"pass,id:1234567\""</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"modsec_edit_rule"</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/Rule-Settings/operation/modsec_get_rules" data-section-id="tag/Rule-Settings/operation/modsec_get_rules" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_get_rules" id="operation/modsec_get_rules" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Settings/operation/modsec_get_rules" aria-label="tag/Rule-Settings/operation/modsec_get_rules"></a>Return ModSecurity rules<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the ModSecurity™ rules from one or more ModSecurity configuration files.</p>
<p><strong>Important:</strong></p>
<ul>
<li>When you disable the
<a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles">Web Server role</a>,
the system disables this function.</li>
<li>You <strong>must</strong> include either the <code>vendor_id</code> <strong>or</strong> the <code>config</code> parameters.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the ModSecurity™ rules from one or more ModSecurity configuration files.</p>
<p><strong>Important:</strong></p>
<ul>
<li>When you disable the
<a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles">Web Server role</a>,
the system disables this function.</li>
<li>You <strong>must</strong> include either the <code>vendor_id</code> <strong>or</strong> the <code>config</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="config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">config</span></td><td class="sc-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">config=modsec_vendor_configs/SomeVendor/config.conf,modsec_vendor_configs/AnotherVendor/config.conf</span> -<!-- --> <!-- -->Call multiple configuration files.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">config=modsec_vendor_configs/SomeVendor/config.conf</span> -<!-- --> <!-- -->Call a single configuration file.</li></ul><div><div html="<p>The file path to the configuration file, relative to the <code>/usr/local/apache/conf</code> directory.</p>
<p><strong>Note:</strong></p>
<p>You can use a comma-delimited list for multiple configuration files.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The file path to the configuration file, relative to the <code>/usr/local/apache/conf</code> directory.</p>
<p><strong>Note:</strong></p>
<p>You can use a comma-delimited list for multiple configuration files.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="exclude_bare_comments" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">exclude_bare_comments</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">exclude_bare_comments=1</span></div><div><div html="<p>Whether to exclude comments that are not associated with any directives.</p>
<ul>
<li><code>1</code> — Exclude.</li>
<li><code>0</code> — Do <strong>not</strong> exclude.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude comments that are not associated with any directives.</p>
<ul>
<li><code>1</code> — Exclude.</li>
<li><code>0</code> — Do <strong>not</strong> exclude.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="exclude_other_directives" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">exclude_other_directives</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">exclude_other_directives=1</span></div><div><div html="<p>Whether the function only returns the <code>SecRule</code> and <code>SecAction</code> directives
from the configuration file, and comments that are not associated with a
rule.</p>
<ul>
<li><code>1</code> — Only return the <code>SecRule</code> and <code>SecAction</code> directives and comments <strong>not</strong>
associated with a rule.</li>
<li><code>0</code> — Return <strong>all</strong> directives and comments.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the function only returns the <code>SecRule</code> and <code>SecAction</code> directives
from the configuration file, and comments that are not associated with a
rule.</p>
<ul>
<li><code>1</code> — Only return the <code>SecRule</code> and <code>SecAction</code> directives and comments <strong>not</strong>
associated with a rule.</li>
<li><code>0</code> — Return <strong>all</strong> directives and comments.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="vendor_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vendor_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> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">vendor_id=vendor=SomeVendor,AnotherVendor</span> -<!-- --> <!-- -->Call multiple vendors.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">vendor_id=SomeVendor</span> -<!-- --> <!-- -->Call a single vendor.</li></ul><div><div html="<p>The vendor&#39;s unique short name.</p>
<p><strong>Note:</strong></p>
<p>You can use a comma-delimited list for multiple vendors.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The vendor's unique short name.</p>
<p><strong>Note:</strong></p>
<p>You can use a comma-delimited list for multiple vendors.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_get_rules</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_get_rules</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kqjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kqjfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kqjfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqjfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kqjfa:0" aria-labelledby="tab:R4kqjfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_get_rules
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqjfa:1" aria-labelledby="tab:R4kqjfa: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:R4sqjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sqjfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sqjfa:0" aria-labelledby="tab:R4sqjfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"chunks"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"config"</span>: <span class="token string">"modsec_vendor_configs/SomeVendor/config.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"config_active"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disabled"</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 number">662452</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_msg"</span>: <span class="token string">"Denied dangerous config traffic"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rule"</span>: <span class="token string">"SecRule REQUEST_FILENAME \"config\" \"deny,id:662452,msg:'Denied dangerous config traffic',severity:1,auditlog\""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"staged"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_active"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_id"</span>: <span class="token string">"SomeVendor"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"staged_changes"</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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_get_rules"</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/Rule-Settings/operation/modsec_remove_rule" data-section-id="tag/Rule-Settings/operation/modsec_remove_rule" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_remove_rule" id="operation/modsec_remove_rule" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Settings/operation/modsec_remove_rule" aria-label="tag/Rule-Settings/operation/modsec_remove_rule"></a>Remove ModSecurity rule<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes a rule from a ModSecurity™ configuration file.</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">Web Server role</a>,
the system disables this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a rule from a ModSecurity™ configuration file.</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">Web Server 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="config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">config</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">config=modsec_vendor_configs/example.conf</span></div><div><div html="<p>The ModSecurity configuration file&#39;s path and filename, relative to the <code>/usr/local/apache/conf/</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity configuration file's path and filename, relative to the <code>/usr/local/apache/conf/</code> directory.</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">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">id=1234567890</span></div><div><div html="<p>The rule&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The rule'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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_remove_rule</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_remove_rule</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4krjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4krjfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4krjfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4krjfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4krjfa:0" aria-labelledby="tab:R4krjfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_remove_rule <span class="token punctuation">\</span>
<span class="token assign-left variable">config</span><span class="token operator">=</span><span class="token string">'modsec_vendor_configs/example.conf'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'1234567890'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4krjfa:1" aria-labelledby="tab:R4krjfa: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:R4srjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4srjfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4srjfa:0" aria-labelledby="tab:R4srjfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_remove_rule"</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/Rule-Settings/operation/modsec_report_rule" data-section-id="tag/Rule-Settings/operation/modsec_report_rule" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_report_rule" id="operation/modsec_report_rule" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Settings/operation/modsec_report_rule" aria-label="tag/Rule-Settings/operation/modsec_report_rule"></a>Export ModSecurity rule error report<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function submits ModSecurity™ rule error reports to a remote receiver. The third
party rule vendors use these error reports to identify problems with their rule sets.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function submits ModSecurity™ rule error reports to a remote receiver. The third
party rule vendors use these error reports to identify problems with their rule sets.</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">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="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=john.doe@example.com</span></div><div><div html="<p>The contact email address to send with the error report. This allows the rule&#39;s vendor to reply to the user directly.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The contact email address to send with the error report. This allows the rule's vendor to reply to the user directly.</p>
</div></div></div></td></tr><tr class=""><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=Hi. We're having some trouble with this rule. It seems to be
blocking all requests.</span></div><div><div html="<p>A short message that explains the reason for the report.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A short message that explains the reason for the report.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="row_ids" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">row_ids</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">row_ids=794828, 794829, 794820</span> -<!-- --> <!-- -->Report multiple row IDs.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">row_ids=794828</span> -<!-- --> <!-- -->Report a single row ID.</li></ul><div><div html="<p>The MySQL® row IDs from the <code>hits</code> table in the <code>modsec</code> database
for the audit log event to report.</p>
<p><strong>Note:</strong></p>
<p>If you specify more than one row ID:</p>
<ul>
<li>You <strong>must</strong> comma-separate the rule IDs.</li>
<li>The rule IDs <strong>must</strong> all correspond to the same ModSecurity rule.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL® row IDs from the <code>hits</code> table in the <code>modsec</code> database
for the audit log event to report.</p>
<p><strong>Note:</strong></p>
<p>If you specify more than one row ID:</p>
<ul>
<li>You <strong>must</strong> comma-separate the rule IDs.</li>
<li>The rule IDs <strong>must</strong> all correspond to the same ModSecurity rule.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="send" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">send</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">send=1</span></div><div><div html="<p>Whether the function sends the report to the rule&#39;s vendor.</p>
<ul>
<li><code>1</code> — Send the report.</li>
<li><code>0</code> — Do <strong>not</strong> send the report.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the function sends the report to the rule's vendor.</p>
<ul>
<li><code>1</code> — Send the report.</li>
<li><code>0</code> — Do <strong>not</strong> send the report.</li>
</ul>
</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=false positive</span></div><div><div html="<p>The report&#39;s type.</p>
<p><strong>Note:</strong></p>
<p>This value does <strong>not</strong> use a specified format. Treat the value as freeform text.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The report's type.</p>
<p><strong>Note:</strong></p>
<p>This value does <strong>not</strong> use a specified format. Treat the value as freeform 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_report_rule</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_report_rule</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4ksjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4ksjfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4ksjfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4ksjfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4ksjfa:0" aria-labelledby="tab:R4ksjfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_report_rule <span class="token punctuation">\</span>
<span class="token assign-left variable">row_ids</span><span class="token operator">=</span><span class="token string">'794828'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">message</span><span class="token operator">=</span><span class="token string">$'Hi. We\'re having some trouble with this rule. It seems to be
blocking all requests.'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'john.doe@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">'false positive'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">send</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:R4ksjfa:1" aria-labelledby="tab:R4ksjfa: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:R4ssjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4ssjfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4ssjfa:0" aria-labelledby="tab:R4ssjfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"report"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"john.doe@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hits"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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_desc"</span>: <span class="token string">"Access denied with code 406 (phase 2)."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"handler"</span>: <span class="token keyword">null</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><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"http_method"</span>: <span class="token string">"GET"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"http_status"</span>: <span class="token number">406</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"http_version"</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">"id"</span>: <span class="token number">794828</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"10.215.215.236"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"justification"</span>: <span class="token string">"Unconditional match in SecAction."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_file"</span>: <span class="token string">"/usr/local/apache/conf/modsec_vendor_configs/MyVendor/one.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_id"</span>: <span class="token number">12345694</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_line"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_logdata"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_msg"</span>: <span class="token string">"Method is not allowed by policy"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_offset"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_rev"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_severity"</span>: <span class="token string">"CRITICAL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_uri"</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">"/something"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timestamp"</span>: <span class="token string">"2019-10-13T07:58:04"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timezone"</span>: <span class="token string">"-300"</span></div></li></ul><span class="token punctuation">}</span></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">"Hi. We're having some trouble with this rule. It seems to be blocking all requests."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rule_text"</span>: <span class="token string">"SecAction \"deny,auditlog,id:'12345694'\"\n"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"false positive"</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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_report_rule"</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/Rule-Settings/operation/modsec_undisable_rule" data-section-id="tag/Rule-Settings/operation/modsec_undisable_rule" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_undisable_rule" id="operation/modsec_undisable_rule" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Settings/operation/modsec_undisable_rule" aria-label="tag/Rule-Settings/operation/modsec_undisable_rule"></a>Enable ModSecurity rule<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables a ModSecurity™ rule.</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 enables a ModSecurity™ rule.</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=""><td kind="field" title="config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">config</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">config=modsec_vendor_configs/example.conf</span></div><div><div html="<p>The ModSecurity configuration file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity configuration file.</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=1234567890</span></div><div><div html="<p>The ModSecurity rule&#39;s ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity rule'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="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">/modsec_undisable_rule</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_undisable_rule</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4ktjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4ktjfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4ktjfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4ktjfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4ktjfa:0" aria-labelledby="tab:R4ktjfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_undisable_rule <span class="token punctuation">\</span>
<span class="token assign-left variable">config</span><span class="token operator">=</span><span class="token string">'modsec_vendor_configs/example.conf'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'1234567890'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4ktjfa:1" aria-labelledby="tab:R4ktjfa: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:R4stjfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4stjfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4stjfa:0" aria-labelledby="tab:R4stjfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"modsec_undisable_rule"</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/Rule-Vendor-Settings" data-section-id="tag/Rule-Vendor-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/Rule-Vendor-Settings" aria-label="tag/Rule-Vendor-Settings"></a>Rule Vendor Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Web Server Security (ModSecurity) / Rule Vendor Settings</p>
"><p>Web Server Security (ModSecurity) / Rule Vendor Settings</p>
</div></div></div><div id="tag/Rule-Vendor-Settings/operation/modsec_add_vendor" data-section-id="tag/Rule-Vendor-Settings/operation/modsec_add_vendor" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_add_vendor" id="operation/modsec_add_vendor" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Vendor-Settings/operation/modsec_add_vendor" aria-label="tag/Rule-Vendor-Settings/operation/modsec_add_vendor"></a>Add ModSecurity vendor rules<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds a new ModSecurity™ vendor rule set to the server.</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">Web Server role</a>,
the system disables this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds a new ModSecurity™ vendor rule set to the server.</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">Web Server 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="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">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">enabled=1</span></div><div><div html="<p>Whether to enable the vendor.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable the vendor.</p>
<ul>
<li><code>1</code> — Enabled.</li>
<li><code>0</code> — Disabled.</li>
</ul>
</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=https://example.com/update/meta_MyVendor.yaml</span></div><div><div html="<p>The YAML metadata that describes the vendor and how to obtain its rules.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The YAML metadata that describes the vendor and how to obtain its rules.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_add_vendor</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_add_vendor</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4khlfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4khlfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4khlfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4khlfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4khlfa:0" aria-labelledby="tab:R4khlfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_add_vendor <span class="token punctuation">\</span>
<span class="token assign-left variable">url</span><span class="token operator">=</span><span class="token string">'https://example.com/update/meta_MyVendor.yaml'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4khlfa:1" aria-labelledby="tab:R4khlfa: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:R4shlfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4shlfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4shlfa:0" aria-labelledby="tab:R4shlfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_url"</span>: <span class="token string">"</span><a href="http://example.com/update/MyVendor.zip">http://example.com/update/MyVendor.zip</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpanel_provided"</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">"This is an example of a custom vendor set (updated)"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dist_md5"</span>: <span class="token string">"307cb5320441ebd712e5581d12100dc9"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dist_sha512"</span>: <span class="token string">"b55c09bb1835ed4209f0f3ea4a70d099665363f23d3819c0369be429438d675ba2c749dcefdb85cee682ee0bf485558e67d0b0965fe4799865529d943e8e14cb"</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">"inst_dist"</span>: <span class="token string">"MyVendor-2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installed_from"</span>: <span class="token string">"</span><a href="https://example.com/update/meta_MyVendor.yaml">https://example.com/update/meta_MyVendor.yaml</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"My Vendor"</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/apache/conf/modsec_vendor_configs/MyVendor"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"report_url"</span>: <span class="token string">"</span><a href="https://waf.example.com/api/cpanel_feedback?source=1&rule_set=1.229">https://waf.example.com/api/cpanel_feedback?source=1&rule_set=1.229</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"supported_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">"2.7.5"</span>,</div></li><li><div class="hoverable "><span class="token string">"2.7.7"</span>,</div></li><li><div class="hoverable "><span class="token string">"2.8.0"</span>,</div></li><li><div class="hoverable "><span class="token string">"2.9.0"</span>,</div></li><li><div class="hoverable "><span class="token string">"2.9.1"</span>,</div></li><li><div class="hoverable "><span class="token string">"2.9.2"</span>,</div></li><li><div class="hoverable "><span class="token string">"2.9.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">"vendor_id"</span>: <span class="token string">"MyVendor"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_url"</span>: <span class="token string">"</span><a href="http://www.example.com">http://www.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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_add_vendor"</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/Rule-Vendor-Settings/operation/modsec_disable_vendor_configs" data-section-id="tag/Rule-Vendor-Settings/operation/modsec_disable_vendor_configs" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_disable_vendor_configs" id="operation/modsec_disable_vendor_configs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Vendor-Settings/operation/modsec_disable_vendor_configs" aria-label="tag/Rule-Vendor-Settings/operation/modsec_disable_vendor_configs"></a>Disable ModSecurity vendor configuration files<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function disables a ModSecurity™ vendor&#39;s configuration files.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables a ModSecurity™ vendor's configuration files.</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">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="vendor_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vendor_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">vendor_id=SomeVendor</span></div><div><div html="<p>The vendor&#39;s unique short name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The vendor's unique short 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_disable_vendor_configs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_disable_vendor_configs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kilfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kilfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kilfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kilfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kilfa:0" aria-labelledby="tab:R4kilfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_disable_vendor_configs <span class="token punctuation">\</span>
<span class="token assign-left variable">vendor_id</span><span class="token operator">=</span><span class="token string">'SomeVendor'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kilfa:1" aria-labelledby="tab:R4kilfa: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:R4silfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4silfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4silfa:0" aria-labelledby="tab:R4silfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"outcomes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"config"</span>: <span class="token string">"modsec_vendor_configs/SomeVendor/example.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exception"</span>: <span class="token string">"This is an error message."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ok"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_disable_vendor_configs"</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/Rule-Vendor-Settings/operation/modsec_disable_vendor_updates" data-section-id="tag/Rule-Vendor-Settings/operation/modsec_disable_vendor_updates" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_disable_vendor_updates" id="operation/modsec_disable_vendor_updates" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Vendor-Settings/operation/modsec_disable_vendor_updates" aria-label="tag/Rule-Vendor-Settings/operation/modsec_disable_vendor_updates"></a>Disable ModSecurity vendor updates<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function disables automatic updates for a ModSecurity™ vendor.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables automatic updates for a ModSecurity™ vendor.</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">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="vendor_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vendor_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">vendor_id=example</span></div><div><div html="<p>The vendor&#39;s unique short name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The vendor's unique short 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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_disable_vendor_updates</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_disable_vendor_updates</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kjlfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kjlfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kjlfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjlfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kjlfa:0" aria-labelledby="tab:R4kjlfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_disable_vendor_updates <span class="token punctuation">\</span>
<span class="token assign-left variable">vendor_id</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:R4kjlfa:1" aria-labelledby="tab:R4kjlfa: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:R4sjlfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sjlfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sjlfa:0" aria-labelledby="tab:R4sjlfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_disable_vendor_updates"</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/Rule-Vendor-Settings/operation/modsec_enable_vendor" data-section-id="tag/Rule-Vendor-Settings/operation/modsec_enable_vendor" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_enable_vendor" id="operation/modsec_enable_vendor" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Vendor-Settings/operation/modsec_enable_vendor" aria-label="tag/Rule-Vendor-Settings/operation/modsec_enable_vendor"></a>Enable ModSecurity vendor rules<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables a ModSecurity™ vendor rule set.</p>
<p><strong>Note:</strong></p>
<p>This function will <strong>not</strong> enable vendor configuration files that you individually
disable.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables a ModSecurity™ vendor rule set.</p>
<p><strong>Note:</strong></p>
<p>This function will <strong>not</strong> enable vendor configuration files that you individually
disable.</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">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="vendor_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vendor_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">vendor_id=SomeVendor</span></div><div><div html="<p>The vendor&#39;s unique short name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The vendor's unique short 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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_enable_vendor</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_enable_vendor</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kklfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kklfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kklfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kklfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kklfa:0" aria-labelledby="tab:R4kklfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_enable_vendor <span class="token punctuation">\</span>
<span class="token assign-left variable">vendor_id</span><span class="token operator">=</span><span class="token string">'SomeVendor'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kklfa:1" aria-labelledby="tab:R4kklfa: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:R4sklfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sklfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sklfa:0" aria-labelledby="tab:R4sklfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_enable_vendor"</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/Rule-Vendor-Settings/operation/modsec_enable_vendor_configs" data-section-id="tag/Rule-Vendor-Settings/operation/modsec_enable_vendor_configs" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_enable_vendor_configs" id="operation/modsec_enable_vendor_configs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Vendor-Settings/operation/modsec_enable_vendor_configs" aria-label="tag/Rule-Vendor-Settings/operation/modsec_enable_vendor_configs"></a>Enable ModSecurity vendor configuration files<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables a ModSecurity™ vendor&#39;s configuration files.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables a ModSecurity™ vendor's configuration files.</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">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="vendor_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vendor_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">vendor_id=SomeVendor</span></div><div><div html="<p>The vendor&#39;s unique short name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The vendor's unique short 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_enable_vendor_configs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_enable_vendor_configs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kllfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kllfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kllfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kllfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kllfa:0" aria-labelledby="tab:R4kllfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_enable_vendor_configs <span class="token punctuation">\</span>
<span class="token assign-left variable">vendor_id</span><span class="token operator">=</span><span class="token string">'SomeVendor'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kllfa:1" aria-labelledby="tab:R4kllfa: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:R4sllfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sllfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sllfa:0" aria-labelledby="tab:R4sllfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"outcomes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"config"</span>: <span class="token string">"modsec_vendor_configs/SomeVendor/example.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exception"</span>: <span class="token string">"This is an error message."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ok"</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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_enable_vendor_configs"</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/Rule-Vendor-Settings/operation/modsec_enable_vendor_updates" data-section-id="tag/Rule-Vendor-Settings/operation/modsec_enable_vendor_updates" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_enable_vendor_updates" id="operation/modsec_enable_vendor_updates" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Vendor-Settings/operation/modsec_enable_vendor_updates" aria-label="tag/Rule-Vendor-Settings/operation/modsec_enable_vendor_updates"></a>Enable ModSecurity vendor updates<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function enables automatic updates for a ModSecurity™ vendor.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables automatic updates for a ModSecurity™ vendor.</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">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="vendor_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vendor_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">vendor_id=example</span></div><div><div html="<p>The vendor&#39;s unique short name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The vendor's unique short 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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_enable_vendor_updates</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_enable_vendor_updates</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kmlfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kmlfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kmlfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmlfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kmlfa:0" aria-labelledby="tab:R4kmlfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_enable_vendor_updates <span class="token punctuation">\</span>
<span class="token assign-left variable">vendor_id</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:R4kmlfa:1" aria-labelledby="tab:R4kmlfa: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:R4smlfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4smlfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4smlfa:0" aria-labelledby="tab:R4smlfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_enable_vendor_updates"</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/Rule-Vendor-Settings/operation/modsec_get_vendors" data-section-id="tag/Rule-Vendor-Settings/operation/modsec_get_vendors" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_get_vendors" id="operation/modsec_get_vendors" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Vendor-Settings/operation/modsec_get_vendors" aria-label="tag/Rule-Vendor-Settings/operation/modsec_get_vendors"></a>Return ModSecurity vendors<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>The function returns a list of configured ModSecurity™ vendors.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>The function returns a list of configured ModSecurity™ vendors.</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">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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_get_vendors</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_get_vendors</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4knlfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4knlfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4knlfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knlfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4knlfa:0" aria-labelledby="tab:R4knlfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_get_vendors
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knlfa:1" aria-labelledby="tab:R4knlfa: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:R4snlfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4snlfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4snlfa:0" aria-labelledby="tab:R4snlfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"vendors"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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_url"</span>: <span class="token string">"</span><a href="http://www.example.com/SAMPLE_1415038544.zip">http://www.example.com/SAMPLE_1415038544.zip</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"configs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"config"</span>: <span class="token string">"modsec_vendor_configs/SAMPLE/modsecurity_crs_10_setup.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_id"</span>: <span class="token string">"SAMPLE"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"config"</span>: <span class="token string">"modsec_vendor_configs/SAMPLE/optional_rules/modsecurity_crs_16_session_hijacking.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_id"</span>: <span class="token string">"SAMPLE"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"config"</span>: <span class="token string">"modsec_vendor_configs/SAMPLE/optional_rules/modsecurity_crs_46_av_scanning.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_id"</span>: <span class="token string">"SAMPLE"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpanel_provided"</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">"A SAMPLE-curated ModSecurity rule set."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dist_md5"</span>: <span class="token string">"ffbaa3a7ead8dfaf0b661a729ce6ad3b"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dist_sha512"</span>: <span class="token string">"b55c09bb1835ed4209f0f3ea4a70d099665363f23d3819c0369be429438d675ba2c749dcefdb85cee682ee0bf485558e67d0b0965fe4799865529d943e8e14cb"</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">"in_use"</span>: <span class="token number">32</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inst_dist"</span>: <span class="token string">"SAMPLE_1415038544"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installed_from"</span>: <span class="token string">"</span><a href="http://www.example.com/meta_SAMPLE.yaml">http://www.example.com/meta_SAMPLE.yaml</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"SAMPLE ModSecurity Core Rule Set"</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/apache/conf/modsec_vendor_configs/SAMPLE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"report_url"</span>: <span class="token string">"</span><a href="https://www.example.com/report">https://www.example.com/report</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"supported_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">"2.9.1"</span>,</div></li><li><div class="hoverable "><span class="token string">"2.9.2"</span>,</div></li><li><div class="hoverable "><span class="token string">"2.9.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">"update"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_id"</span>: <span class="token string">"SAMPLE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_url"</span>: <span class="token string">"</span><a href="https://www.example.com/index.php/Category:SAMPLE_ModSecurity_Core_Rule_Set_Project">https://www.example.com/index.php/Category:SAMPLE_ModSecurity_Core_Rule_Set_Project</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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_get_vendors"</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/Rule-Vendor-Settings/operation/modsec_disable_vendor" data-section-id="tag/Rule-Vendor-Settings/operation/modsec_disable_vendor" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_disable_vendor" id="operation/modsec_disable_vendor" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Vendor-Settings/operation/modsec_disable_vendor" aria-label="tag/Rule-Vendor-Settings/operation/modsec_disable_vendor"></a>Disable ModSecurity vendor rules<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function disables a ModSecurity™ vendor rule set.</p>
<p><strong>Note:</strong></p>
<p>This function will <strong>not</strong> disable vendor configuration files that you have individually enabled.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables a ModSecurity™ vendor rule set.</p>
<p><strong>Note:</strong></p>
<p>This function will <strong>not</strong> disable vendor configuration files that you have individually enabled.</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">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="vendor_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vendor_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">vendor_id=SomeVendor</span></div><div><div html="<p>The vendor&#39;s unique short name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The vendor's unique short 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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_disable_vendor</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_disable_vendor</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kolfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kolfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kolfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kolfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kolfa:0" aria-labelledby="tab:R4kolfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_disable_vendor <span class="token punctuation">\</span>
<span class="token assign-left variable">vendor_id</span><span class="token operator">=</span><span class="token string">'SomeVendor'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kolfa:1" aria-labelledby="tab:R4kolfa: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:R4solfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4solfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4solfa:0" aria-labelledby="tab:R4solfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_disable_vendor"</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/Rule-Vendor-Settings/operation/modsec_preview_vendor" data-section-id="tag/Rule-Vendor-Settings/operation/modsec_preview_vendor" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_preview_vendor" id="operation/modsec_preview_vendor" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Vendor-Settings/operation/modsec_preview_vendor" aria-label="tag/Rule-Vendor-Settings/operation/modsec_preview_vendor"></a>Return ModSecurity vendor rule metadata<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function returns the metadata for a ModSecurity™ vendor rule set.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the metadata for a ModSecurity™ vendor rule set.</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">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="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=https://www.example.com/vendor1rules/meta_vendor1.yaml</span></div><div><div html="<p>The YAML metadata&#39;s URL, which describes the vendor and how to obtain its rules.</p>
<p><strong>Note:</strong></p>
<ul>
<li>The file uses YAML format.</li>
<li>The filename <strong>must</strong> use the <code>meta_</code> prefix.</li>
<li>The filename <strong>must</strong> match the <code>vendor_id</code> value for your vendor.</li>
<li>The filename <strong>must</strong> end with the <code>.yaml</code> extension.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The YAML metadata's URL, which describes the vendor and how to obtain its rules.</p>
<p><strong>Note:</strong></p>
<ul>
<li>The file uses YAML format.</li>
<li>The filename <strong>must</strong> use the <code>meta_</code> prefix.</li>
<li>The filename <strong>must</strong> match the <code>vendor_id</code> value for your vendor.</li>
<li>The filename <strong>must</strong> end with the <code>.yaml</code> extension.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_preview_vendor</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_preview_vendor</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kplfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kplfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kplfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kplfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kplfa:0" aria-labelledby="tab:R4kplfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_preview_vendor <span class="token punctuation">\</span>
<span class="token assign-left variable">url</span><span class="token operator">=</span><span class="token string">'https://www.example.com/vendor1rules/meta_vendor1.yaml'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kplfa:1" aria-labelledby="tab:R4kplfa: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:R4splfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4splfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4splfa:0" aria-labelledby="tab:R4splfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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_url"</span>: <span class="token string">"</span><a href="https://www.example.com/vendor1.zip">https://www.example.com/vendor1.zip</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpanel_provided"</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">"This is the Vendor1 ModSecurity Core Rule Set."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dist_md5"</span>: <span class="token string">"307cb5320441ebd712e5581d12100dc9"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dist_sha512"</span>: <span class="token string">"b55c09bb1835ed4209f0f3ea4a70d099665363f23d3819c0369be429438d675ba2c749dcefdb85cee682ee0bf485558e67d0b0965fe4799865529d943e8e14cb"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installed_from"</span>: <span class="token string">"</span><a href="https://www.example.com/vendor1rules/meta_vendor1.yaml">https://www.example.com/vendor1rules/meta_vendor1.yaml</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Vendor1 ModSecurity Core Rule Set"</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/apache/conf/modsec_vendor_configs/vendor1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"report_url"</span>: <span class="token string">"</span><a href="https://waf.example.com/api/cpanel_feedback?source=1&rule_set=1.229">https://waf.example.com/api/cpanel_feedback?source=1&rule_set=1.229</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"supported_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">"2.9.1"</span>,</div></li><li><div class="hoverable "><span class="token string">"2.9.2"</span>,</div></li><li><div class="hoverable "><span class="token string">"2.9.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">"vendor_id"</span>: <span class="token string">"vendor1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_url"</span>: <span class="token string">"</span><a href="http://www.example.com">http://www.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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_preview_vendor"</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/Rule-Vendor-Settings/operation/modsec_remove_vendor" data-section-id="tag/Rule-Vendor-Settings/operation/modsec_remove_vendor" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_remove_vendor" id="operation/modsec_remove_vendor" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Vendor-Settings/operation/modsec_remove_vendor" aria-label="tag/Rule-Vendor-Settings/operation/modsec_remove_vendor"></a>Remove ModSecurity vendor<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes a ModSecurity™ vendor. When you call this function, the system
removes the vendor&#39;s includes, disablement directives, configuration files, and
metadata file.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a ModSecurity™ vendor. When you call this function, the system
removes the vendor's includes, disablement directives, configuration files, and
metadata file.</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">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="vendor_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vendor_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">vendor_id=SomeVendor</span></div><div><div html="<p>The ModSecurity vendor&#39;s unique short name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity vendor's unique short 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="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">/modsec_remove_vendor</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_remove_vendor</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kqlfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kqlfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kqlfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqlfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kqlfa:0" aria-labelledby="tab:R4kqlfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_remove_vendor <span class="token punctuation">\</span>
<span class="token assign-left variable">vendor_id</span><span class="token operator">=</span><span class="token string">'SomeVendor'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqlfa:1" aria-labelledby="tab:R4kqlfa: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:R4sqlfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sqlfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sqlfa:0" aria-labelledby="tab:R4sqlfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"modsec_remove_vendor"</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/Rule-Vendor-Settings/operation/modsec_update_vendor" data-section-id="tag/Rule-Vendor-Settings/operation/modsec_update_vendor" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_update_vendor" id="operation/modsec_update_vendor" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Rule-Vendor-Settings/operation/modsec_update_vendor" aria-label="tag/Rule-Vendor-Settings/operation/modsec_update_vendor"></a>Update ModSecurity vendor ruleset<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function updates a vendor with the current version of the rule set.</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">Web Server role</a>,
the system disables this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates a vendor with the current version of the rule set.</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">Web Server 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="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://example.com/update/meta_MyVendor.yaml</span></div><div><div html="<p>The vendor metadata file&#39;s URL.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The vendor metadata file's URL.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_update_vendor</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_update_vendor</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4krlfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4krlfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4krlfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4krlfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4krlfa:0" aria-labelledby="tab:R4krlfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_update_vendor <span class="token punctuation">\</span>
<span class="token assign-left variable">url</span><span class="token operator">=</span><span class="token string">'http://example.com/update/meta_MyVendor.yaml'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4krlfa:1" aria-labelledby="tab:R4krlfa: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:R4srlfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4srlfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4srlfa:0" aria-labelledby="tab:R4srlfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"diagnostics"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"added_configs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"modsec_vendor_configs/MyVendor/three.conf"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted_configs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"modsec_vendor_configs/MyVendor/one.conf"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"new_configs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"config"</span>: <span class="token string">"modsec_vendor_configs/MyVendor/two.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_id"</span>: <span class="token string">"MyVendor"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prev_configs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"config"</span>: <span class="token string">"modsec_vendor_configs/MyVendor/two.conf"</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">"vendor"</span>: <button class="collapser" aria-label="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_url"</span>: <span class="token string">"</span><a href="http://example.com/update/MyVendor.zip">http://example.com/update/MyVendor.zip</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpanel_provided"</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">"This is an example of a custom vendor set (updated)."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dist_md5"</span>: <span class="token string">"ecafce1bf148532250a8d4743a8374d1"</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">"inst_dist"</span>: <span class="token string">"MyVendor-2"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installed_from"</span>: <span class="token string">"</span><a href="http://example.com/update/meta_MyVendor.yaml">http://example.com/update/meta_MyVendor.yaml</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"My Vendor"</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/apache/conf/modsec_vendor_configs/MyVendor"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"report_url"</span>: <span class="token string">"</span><a href="http://example.com/report/">http://example.com/report/</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_id"</span>: <span class="token string">"MyVendor"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_url"</span>: <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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_update_vendor"</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/Server-Settings" data-section-id="tag/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/Server-Settings" aria-label="tag/Server-Settings"></a>Server Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="<p>Web Server Security (ModSecurity) / Server Settings</p>
"><p>Web Server Security (ModSecurity) / Server Settings</p>
</div></div></div><div id="tag/Server-Settings/operation/modsec_assemble_config_text" data-section-id="tag/Server-Settings/operation/modsec_assemble_config_text" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_assemble_config_text" id="operation/modsec_assemble_config_text" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Settings/operation/modsec_assemble_config_text" aria-label="tag/Server-Settings/operation/modsec_assemble_config_text"></a>Add ModSecurity configuration file text<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds text to a ModSecurity™ configuration file.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds text to a ModSecurity™ configuration file.</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">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="config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">config</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">config=modsec_vendor_configs/example.conf</span></div><div><div html="<p>The ModSecurity™ configuration filename and file path, relative to the <code>/etc/apache2/conf/</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity™ configuration filename and file path, relative to the <code>/etc/apache2/conf/</code> directory.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="deploy" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">deploy</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">deploy=1</span></div><div><div html="<p>Whether to deploy the new text to the system.</p>
<ul>
<li><code>1</code> — Deploy.</li>
<li><code>0</code> — Do <strong>not</strong> deploy.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to deploy the new text to the system.</p>
<ul>
<li><code>1</code> — Deploy.</li>
<li><code>0</code> — Do <strong>not</strong> deploy.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="final" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">final</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">final=1</span></div><div><div html="<p>Whether to add the text as the final upload to the configuration file.</p>
<ul>
<li><code>1</code> — Final upload.</li>
<li><code>0</code> — <strong>Not</strong> the final upload.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>must</strong> use this parameter if you wish to add the text as the final
change to the configuration file.</li>
<li>You <strong>must</strong> use the <code>init</code> parameter with this parameter if you wish to
only make one change to the configuration file.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to add the text as the final upload to the configuration file.</p>
<ul>
<li><code>1</code> — Final upload.</li>
<li><code>0</code> — <strong>Not</strong> the final upload.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>must</strong> use this parameter if you wish to add the text as the final
change to the configuration file.</li>
<li>You <strong>must</strong> use the <code>init</code> parameter with this parameter if you wish to
only make one change to the configuration file.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="init" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">init</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">init=1</span></div><div><div html="<p>Whether to add the text as the initial upload to the configuration file.</p>
<ul>
<li><code>1</code> — Initial upload.</li>
<li><code>0</code> — <strong>Not</strong> the initial upload.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>must</strong> use this parameter if you wish to add the text as the initial
change to the configuration file.</li>
<li>You <strong>must</strong> use the <code>final</code> parameter with this parameter if you wish to
only make one change to the configuration file.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to add the text as the initial upload to the configuration file.</p>
<ul>
<li><code>1</code> — Initial upload.</li>
<li><code>0</code> — <strong>Not</strong> the initial upload.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>must</strong> use this parameter if you wish to add the text as the initial
change to the configuration file.</li>
<li>You <strong>must</strong> use the <code>final</code> parameter with this parameter if you wish to
only make one change to the configuration file.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="text" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">text</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="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">text=newtext</span></div><div><div html="<p>The text to add to the configuration file.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The text to add to the configuration 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="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">/modsec_assemble_config_text</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_assemble_config_text</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4khnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4khnfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4khnfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4khnfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4khnfa:0" aria-labelledby="tab:R4khnfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_assemble_config_text <span class="token punctuation">\</span>
<span class="token assign-left variable">config</span><span class="token operator">=</span><span class="token string">'modsec_vendor_configs/example.conf'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4khnfa:1" aria-labelledby="tab:R4khnfa: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:R4shnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4shnfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4shnfa:0" aria-labelledby="tab:R4shnfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="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">"modsec_assemble_config_text"</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/Server-Settings/operation/modsec_batch_settings" data-section-id="tag/Server-Settings/operation/modsec_batch_settings" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_batch_settings" id="operation/modsec_batch_settings" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Settings/operation/modsec_batch_settings" aria-label="tag/Server-Settings/operation/modsec_batch_settings"></a>Run ModSecurity batch settings<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds, updates, and removes global ModSecurity™ configuration directives.
The function modifies these directives in the <code>/usr/local/apache/conf/modsec2.cpanel.conf</code>
file.</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>
<p>This function <strong>only</strong> supports the following ModSecurity™ configuration directives:</p>
<table>
<tr><th>setting_id</th><th>Documentation</th></tr>
<tr><td>0</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secauditengine">SecAuditEngine</a></td></tr>
<tr><td>1</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secconnengine">SecConnEngine</a></td></tr>
<tr><td>2</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secruleengine">SecRuleEngine</a></td></tr>
<tr><td>3</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secdisablebackendcompression">SecDisableBackendCompression</a></td></tr>
<tr><td>4</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secgeolookupdb">SecGeoLookupDb</a></td></tr>
<tr><td>5</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secgsblookupdb">SecGsbLookupDb</a></td></tr>
<tr><td>6</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secguardianlog">SecGuardianLog</a></td></tr>
<tr><td>7</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#sechttpblkey">SecHttpBlKey</a></td></tr>
<tr><td>8</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secpcrematchlimit">SecPcreMatchLimit</a></td></tr>
<tr><td>9</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secpcrematchlimitrecursion">SecPcreMatchLimitRecursion</a></td></tr>
</table>" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds, updates, and removes global ModSecurity™ configuration directives.
The function modifies these directives in the <code>/usr/local/apache/conf/modsec2.cpanel.conf</code>
file.</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>
<p>This function <strong>only</strong> supports the following ModSecurity™ configuration directives:</p>
<table>
<tr><th>setting_id</th><th>Documentation</th></tr>
<tr><td>0</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secauditengine">SecAuditEngine</a></td></tr>
<tr><td>1</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secconnengine">SecConnEngine</a></td></tr>
<tr><td>2</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secruleengine">SecRuleEngine</a></td></tr>
<tr><td>3</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secdisablebackendcompression">SecDisableBackendCompression</a></td></tr>
<tr><td>4</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secgeolookupdb">SecGeoLookupDb</a></td></tr>
<tr><td>5</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secgsblookupdb">SecGsbLookupDb</a></td></tr>
<tr><td>6</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secguardianlog">SecGuardianLog</a></td></tr>
<tr><td>7</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#sechttpblkey">SecHttpBlKey</a></td></tr>
<tr><td>8</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secpcrematchlimit">SecPcreMatchLimit</a></td></tr>
<tr><td>9</td><td><a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secpcrematchlimitrecursion">SecPcreMatchLimitRecursion</a></td></tr>
</table></div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><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"></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> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">remove=remove1=0 remove2=1 remove3=0</span> -<!-- --> <!-- -->Remove some settings when updating or setting multiple configuration settings. This example removes the second setting indicated in `setting_id2` and updates the other two settings.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">remove=1</span> -<!-- --> <!-- -->Remove a single configuration setting requested in the `setting_id`</li></ul><div><div html="<p>Whether to add or remove the configuration setting in the
<code>/usr/local/apache/conf/modsec2.cpanel.conf</code> file.</p>
<ul>
<li><p><code>1</code> — Remove the configuration setting.</p>
</li>
<li><p><code>0</code> — Add or update the configuration setting.</p>
</li>
<li><p>To remove multiple settings, increment the parameter name. For example, <code>remove1</code>,
<code>remove2</code>, and <code>remove3</code>.</p>
</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to add or remove the configuration setting in the
<code>/usr/local/apache/conf/modsec2.cpanel.conf</code> file.</p>
<ul>
<li><p><code>1</code> — Remove the configuration setting.</p>
</li>
<li><p><code>0</code> — Add or update the configuration setting.</p>
</li>
<li><p>To remove multiple settings, increment the parameter name. For example, <code>remove1</code>,
<code>remove2</code>, and <code>remove3</code>.</p>
</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="setting_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">setting_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"> <!-- -->[ 0 .. 9 ]<!-- --> </span></span></div> <span class="sc-CNKsk hPAOR"> <!-- -->Examples<!-- -->: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">setting_id=setting_id1=1 setting_id2=2 setting_id3=3</span> -<!-- --> <!-- -->Set or update multiple configuration settings, in this case: SecConnEngine, SecRuleEngine, and SecDisableBackendCompression.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">setting_id=1</span> -<!-- --> <!-- -->Set or update a single configuration setting, in this case for SecConnEngine.</li></ul><div><div html="<p>The configuration setting&#39;s ID.</p>
<p><strong>Note:</strong></p>
<p>To configure multiple IDs, increment the parameter name. For example, <code>setting_id1</code>,
<code>setting_id2</code>, and <code>setting_id3</code>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The configuration setting's ID.</p>
<p><strong>Note:</strong></p>
<p>To configure multiple IDs, increment the parameter name. For example, <code>setting_id1</code>,
<code>setting_id2</code>, and <code>setting_id3</code>.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="state" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand state"><span class="property-name">state</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 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 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">state=state1=On state2=On state3=Off</span> -<!-- --> <!-- -->Set the state of multiple configuration settings.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">state=On</span> -<!-- --> <!-- -->Set the state of a single configuration setting.</li></ul><div><div html="<p>The configuration setting&#39;s current state.</p>
<ul>
<li><code>On</code></li>
<li><code>Off</code></li>
</ul>
<p>Some settings accept additional values for this parameter. See the references above for more inforamation.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To configure multiple settings, increment the parameter name. For example, <code>state1</code>,
<code>state2</code>, and <code>state3</code>.</li>
<li><code>state</code> is ignored if <code>remove</code> is set to <code>1</code> for the setting.</li>
</ul>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The configuration setting's current state.</p>
<ul>
<li><code>On</code></li>
<li><code>Off</code></li>
</ul>
<p>Some settings accept additional values for this parameter. See the references above for more inforamation.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To configure multiple settings, increment the parameter name. For example, <code>state1</code>,
<code>state2</code>, and <code>state3</code>.</li>
<li><code>state</code> is ignored if <code>remove</code> is set to <code>1</code> for the setting.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_batch_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_batch_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:R4kinfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kinfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kinfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kinfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kinfa:0" aria-labelledby="tab:R4kinfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_batch_settings <span class="token punctuation">\</span>
<span class="token assign-left variable">setting_id</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">state</span><span class="token operator">=</span><span class="token string">'On'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kinfa:1" aria-labelledby="tab:R4kinfa: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:R4sinfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sinfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sinfa:0" aria-labelledby="tab:R4sinfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"updated_settings"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"define the match limit of the PCRE library."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"directive"</span>: <span class="token string">"SecAuditEngine"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"engine"</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">"Audit Log Level"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"radio_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">"name"</span>: <span class="token string">"Log all transactions."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"option"</span>: <span class="token string">"On"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setting_id"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">"On"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"radio"</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://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secpcrematchlimit">https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secpcrematchlimit</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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_batch_settings"</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/Server-Settings/operation/modsec_get_config_text" data-section-id="tag/Server-Settings/operation/modsec_get_config_text" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_get_config_text" id="operation/modsec_get_config_text" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Settings/operation/modsec_get_config_text" aria-label="tag/Server-Settings/operation/modsec_get_config_text"></a>Return ModSecurity configuration file<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves a ModSecurity™ configuration file&#39;s 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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a ModSecurity™ configuration file's 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">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="config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">config</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">config=modsec2.example.conf</span></div><div><div html="<p>The ModSecurity configuration file&#39;s name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity configuration file'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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_get_config_text</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_get_config_text</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kjnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kjnfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kjnfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjnfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kjnfa:0" aria-labelledby="tab:R4kjnfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_get_config_text <span class="token punctuation">\</span>
<span class="token assign-left variable">config</span><span class="token operator">=</span><span class="token string">'modsec2.example.conf'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjnfa:1" aria-labelledby="tab:R4kjnfa: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:R4sjnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sjnfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sjnfa:0" aria-labelledby="tab:R4sjnfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">"SecRule REQUEST_URI \"example\" \"deny:id:123456789\" SecAction \"pass:auditlog:id:444444444\""</span></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">"command"</span>: <span class="token string">"modsec_get_config_text"</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/Server-Settings/operation/modsec_get_configs" data-section-id="tag/Server-Settings/operation/modsec_get_configs" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_get_configs" id="operation/modsec_get_configs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Settings/operation/modsec_get_configs" aria-label="tag/Server-Settings/operation/modsec_get_configs"></a>Return all ModSecurity configuration files<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists ModSecurity™ configuration files. The system stores the configuration
files in the <code>/usr/local/apache/conf/modsec_vendor_configs</code> 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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists ModSecurity™ configuration files. The system stores the configuration
files in the <code>/usr/local/apache/conf/modsec_vendor_configs</code> 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">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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_get_configs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_get_configs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kknfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kknfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kknfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kknfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kknfa:0" aria-labelledby="tab:R4kknfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_get_configs
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kknfa:1" aria-labelledby="tab:R4kknfa: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:R4sknfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sknfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sknfa:0" aria-labelledby="tab:R4sknfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"configs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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">"config"</span>: <span class="token string">"modsec_vendor_configs/MyVendor/one.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vendor_id"</span>: <span class="token string">"MyVendor"</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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_get_configs"</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/Server-Settings/operation/modsec_get_configs_with_changes_pending" data-section-id="tag/Server-Settings/operation/modsec_get_configs_with_changes_pending" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_get_configs_with_changes_pending" id="operation/modsec_get_configs_with_changes_pending" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Settings/operation/modsec_get_configs_with_changes_pending" aria-label="tag/Server-Settings/operation/modsec_get_configs_with_changes_pending"></a>Return staged ModSecurity configuration files<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function lists the ModSecurity™ configuration files that have staged changes.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the ModSecurity™ configuration files that have staged changes.</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">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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_get_configs_with_changes_pending</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_get_configs_with_changes_pending</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4klnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4klnfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4klnfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4klnfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4klnfa:0" aria-labelledby="tab:R4klnfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_get_configs_with_changes_pending
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4klnfa:1" aria-labelledby="tab:R4klnfa: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:R4slnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4slnfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4slnfa:0" aria-labelledby="tab:R4slnfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"configs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"modsec2.user.conf"</span>,</div></li><li><div class="hoverable "><span class="token string">"modsec2.user1.conf"</span>,</div></li><li><div class="hoverable "><span class="token string">"modsec2.user2.conf"</span></div></li></ul><span class="token punctuation">]</span></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">"command"</span>: <span class="token string">"modsec_get_configs_with_changes_pending"</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/Server-Settings/operation/modsec_get_log" data-section-id="tag/Server-Settings/operation/modsec_get_log" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_get_log" id="operation/modsec_get_log" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Settings/operation/modsec_get_log" aria-label="tag/Server-Settings/operation/modsec_get_log"></a>Return ModSecurity logs<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves ModSecurity™ log entries from the modsec MySQL® database.</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">Web Server role</a>,
the system disables this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves ModSecurity™ log entries from the modsec MySQL® database.</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">Web Server 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.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="<p>An array of objects that contains information about the log entry.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An array of objects that contains information about the log entry.</p>
</div></div></div></td></tr><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">/modsec_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_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:R4kmnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kmnfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kmnfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmnfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kmnfa:0" aria-labelledby="tab:R4kmnfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_get_log
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmnfa:1" aria-labelledby="tab:R4kmnfa: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:R4smnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4smnfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4smnfa:0" aria-labelledby="tab:R4smnfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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_desc"</span>: <span class="token string">"Access denied with code 406 (phase 1)."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_exists"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"handler"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host"</span>: <span class="token string">"server.example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"http_method"</span>: <span class="token string">"GET"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"http_status"</span>: <span class="token number">406</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"http_version"</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">"id"</span>: <span class="token number">28</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"10.1.14.77"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"justification"</span>: <span class="token string">"Match of \"within %{tx.allowed_methods}\" against \"REQUEST_METHOD\" required."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_file"</span>: <span class="token string">"/usr/local/apache/conf/modsec_vendor_configs/OWASP/base_rules/modsecurity_crs_30_http_policy.conf"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_id"</span>: <span class="token number">960032</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_line"</span>: <span class="token number">31</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_logdata"</span>: <span class="token string">"GET"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_msg"</span>: <span class="token string">"Method is not allowed by policy"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_offset"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_rev"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_severity"</span>: <span class="token string">"CRITICAL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta_uri"</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">"/favicon.ico"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reportable"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timestamp"</span>: <span class="token string">"2019-10-13T07:58:04"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timezone"</span>: <span class="token number">-300</span></div></li></ul><span class="token punctuation">}</span></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">"command"</span>: <span class="token string">"modsec_get_log"</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/Server-Settings/operation/modsec_get_settings" data-section-id="tag/Server-Settings/operation/modsec_get_settings" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_get_settings" id="operation/modsec_get_settings" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Settings/operation/modsec_get_settings" aria-label="tag/Server-Settings/operation/modsec_get_settings"></a>Return ModSecurity configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function retrieves the server&#39;s ModSecurity™ configuration settings. The system
stores these settings in the <code>/usr/local/apache/conf/modsec2.conf</code> file.</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 retrieves the server's ModSecurity™ configuration settings. The system
stores these settings in the <code>/usr/local/apache/conf/modsec2.conf</code> file.</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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_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:R4knnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4knnfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4knnfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knnfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4knnfa:0" aria-labelledby="tab:R4knnfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_get_settings
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knnfa:1" aria-labelledby="tab:R4knnfa: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:R4snnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4snnfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4snnfa:0" aria-labelledby="tab:R4snnfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"settings"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="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"</span>: <span class="token string">"Off"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"This setting controls the behavior of the audit engine."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"directive"</span>: <span class="token string">"SecAuditEngine"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"engine"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"missing"</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">"Audit Log Level"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"radio_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">"name"</span>: <span class="token string">"Log all transactions."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"option"</span>: <span class="token string">"On"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Do not log any transactions."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"option"</span>: <span class="token string">"Off"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="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">"Only log noteworthy transactions."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"option"</span>: <span class="token string">"RelevantOnly"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setting_id"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</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">"radio"</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://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secauditengine">https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secauditengine</a><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">"description"</span>: <span class="token string">"Specify an external program to pipe transaction log information to for additional analysis. The syntax is analogous to the .forward file, in which a pipe at the beginning of the field indicates piping to an external program."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"directive"</span>: <span class="token string">"SecGuardianLog"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"missing"</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">"Guardian Log"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setting_id"</span>: <span class="token number">6</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</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">"text"</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://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secguardianlog">https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secguardianlog</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"arg"</span>: <span class="token string">"[|]"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"startsWith"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><span class="token string">"path"</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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_get_settings"</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/Server-Settings/operation/modsec_is_installed" data-section-id="tag/Server-Settings/operation/modsec_is_installed" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_is_installed" id="operation/modsec_is_installed" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Settings/operation/modsec_is_installed" aria-label="tag/Server-Settings/operation/modsec_is_installed"></a>Return ModSecurity module status<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function checks whether the ModSecurity™ module is installed.</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">Web Server role</a>, the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the ModSecurity™ module is installed.</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">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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_is_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 WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_is_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:R4konfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4konfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4konfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4konfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4konfa:0" aria-labelledby="tab:R4konfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_is_installed
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4konfa:1" aria-labelledby="tab:R4konfa: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:R4sonfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sonfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sonfa:0" aria-labelledby="tab:R4sonfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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></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">"command"</span>: <span class="token string">"modsec_is_installed"</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/Server-Settings/operation/modsec_make_config_inactive" data-section-id="tag/Server-Settings/operation/modsec_make_config_inactive" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_make_config_inactive" id="operation/modsec_make_config_inactive" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Settings/operation/modsec_make_config_inactive" aria-label="tag/Server-Settings/operation/modsec_make_config_inactive"></a>Remove ModSecurity configuration file include<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes an include for a ModSecurity™ configuration file from
the <code>modsec2.cpanel.conf</code> file. This makes the ModSecurity configuration file
inactive.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes an include for a ModSecurity™ configuration file from
the <code>modsec2.cpanel.conf</code> file. This makes the ModSecurity configuration file
inactive.</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">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="config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">config</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">config=modsec_vendor_configs/example.conf</span></div><div><div html="<p>The ModSecurity configuration file&#39;s path and filename, relative to the <code>/etc/apache2/conf.d/</code> directory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity configuration file's path and filename, relative to the <code>/etc/apache2/conf.d/</code> 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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_make_config_inactive</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_make_config_inactive</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kpnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kpnfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kpnfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kpnfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kpnfa:0" aria-labelledby="tab:R4kpnfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_make_config_inactive <span class="token punctuation">\</span>
<span class="token assign-left variable">config</span><span class="token operator">=</span><span class="token string">'modsec_vendor_configs/example.conf'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kpnfa:1" aria-labelledby="tab:R4kpnfa: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:R4spnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4spnfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4spnfa:0" aria-labelledby="tab:R4spnfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_make_config_inactive"</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/Server-Settings/operation/modsec_make_config_active" data-section-id="tag/Server-Settings/operation/modsec_make_config_active" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_make_config_active" id="operation/modsec_make_config_active" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Settings/operation/modsec_make_config_active" aria-label="tag/Server-Settings/operation/modsec_make_config_active"></a>Add ModSecurity configuration file include<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function adds an include for a ModSecurity™ configuration file to
the <code>modsec2.cpanel.conf</code> file. This makes the ModSecurity configuration file
active.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds an include for a ModSecurity™ configuration file to
the <code>modsec2.cpanel.conf</code> file. This makes the ModSecurity configuration file
active.</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">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="config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">config</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">config=modsec_vendor_configs/example.conf</span></div><div><div html="<p>The ModSecurity configuration file&#39;s path and filename, relative to the <code>/usr/local/apache/conf/</code> diretory.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ModSecurity configuration file's path and filename, relative to the <code>/usr/local/apache/conf/</code> diretory.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>HTTP Request was successful.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_make_config_active</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_make_config_active</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kqnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kqnfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kqnfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqnfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kqnfa:0" aria-labelledby="tab:R4kqnfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_make_config_active <span class="token punctuation">\</span>
<span class="token assign-left variable">config</span><span class="token operator">=</span><span class="token string">'modsec_vendor_configs/example.conf'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqnfa:1" aria-labelledby="tab:R4kqnfa: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:R4sqnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sqnfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sqnfa:0" aria-labelledby="tab:R4sqnfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_make_config_active"</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/Server-Settings/operation/modsec_remove_setting" data-section-id="tag/Server-Settings/operation/modsec_remove_setting" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_remove_setting" id="operation/modsec_remove_setting" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Settings/operation/modsec_remove_setting" aria-label="tag/Server-Settings/operation/modsec_remove_setting"></a>Remove ModSecurity configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function removes a global ModSecurity™ configuration directive.</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">Web Server role</a>,
the system disables this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a global ModSecurity™ configuration directive.</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">Web Server 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="setting_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">setting_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">setting_id=3</span></div><div><div html="<p>The setting&#39;s ID. For a list of available settings and their IDs, call the <code>modsec_get_settings</code> function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The setting's ID. For a list of available settings and their IDs, call the <code>modsec_get_settings</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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_remove_setting</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_remove_setting</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4krnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4krnfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4krnfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4krnfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4krnfa:0" aria-labelledby="tab:R4krnfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_remove_setting <span class="token punctuation">\</span>
<span class="token assign-left variable">setting_id</span><span class="token operator">=</span><span class="token string">'3'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4krnfa:1" aria-labelledby="tab:R4krnfa: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:R4srnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4srnfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4srnfa:0" aria-labelledby="tab:R4srnfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_remove_setting"</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/Server-Settings/operation/modsec_set_config_text" data-section-id="tag/Server-Settings/operation/modsec_set_config_text" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_set_config_text" id="operation/modsec_set_config_text" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Settings/operation/modsec_set_config_text" aria-label="tag/Server-Settings/operation/modsec_set_config_text"></a>Update ModSecurity configuration file<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets the contents of a specified ModSecurity™ configuration file. The system
stages any changes to the configuration file. To deploy the changes, call WHM API 1&#39;s
<code>modsec_deploy_rule_changes</code> function.</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">Web Server role</a>,
the system disables this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the contents of a specified ModSecurity™ configuration file. The system
stages any changes to the configuration file. To deploy the changes, call WHM API 1's
<code>modsec_deploy_rule_changes</code> function.</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">Web Server 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="config" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">config</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">config=modsec2.example.conf</span></div><div><div html="<p>The configuration file name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The configuration file name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="text" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">text</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">text=SecRule REQUEST_URI "example" "deny,id:123456789" SecAction "pass,auditlog,id"</span></div><div><div html="<p>The configuration text.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The configuration 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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><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="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">/modsec_set_config_text</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_set_config_text</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4ksnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4ksnfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4ksnfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4ksnfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4ksnfa:0" aria-labelledby="tab:R4ksnfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_set_config_text <span class="token punctuation">\</span>
<span class="token assign-left variable">config</span><span class="token operator">=</span><span class="token string">'modsec2.example.conf'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">text</span><span class="token operator">=</span><span class="token string">'SecRule REQUEST_URI "example" "deny,id:123456789" SecAction "pass,auditlog,id"'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4ksnfa:1" aria-labelledby="tab:R4ksnfa: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:R4ssnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4ssnfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4ssnfa:0" aria-labelledby="tab:R4ssnfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_set_config_text"</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/Server-Settings/operation/modsec_set_setting" data-section-id="tag/Server-Settings/operation/modsec_set_setting" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_set_setting" id="operation/modsec_set_setting" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Settings/operation/modsec_set_setting" aria-label="tag/Server-Settings/operation/modsec_set_setting"></a>Update ModSecurity configuration<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function sets a global ModSecurity™ configuration directive.</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 sets a global ModSecurity™ configuration directive.</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=""><td kind="field" title="setting_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">setting_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"> <!-- -->>= 0<!-- --> </span></span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">setting_id=8</span></div><div><div html="<p>The setting&#39;s ID.</p>
<p><strong>Note:</strong></p>
<p> The WHM API 1 <code>modsec_get_settings</code> function returns this value.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The setting's ID.</p>
<p><strong>Note:</strong></p>
<p> The WHM API 1 <code>modsec_get_settings</code> function returns this value.</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">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">state=2000</span></div><div><div html="<p>The setting&#39;s new state. The function uses this as a valid argument
for the directive.</p>
<p><strong>Note:</strong></p>
<p> For more information, read SpiderLabs&#39; <a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual">ModSecurity documentation</a>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The setting's new state. The function uses this as a valid argument
for the directive.</p>
<p><strong>Note:</strong></p>
<p> For more information, read SpiderLabs' <a href="https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual">ModSecurity 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="data" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand data"><span class="property-name">data</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_set_setting</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_set_setting</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4ktnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4ktnfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4ktnfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4ktnfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4ktnfa:0" aria-labelledby="tab:R4ktnfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_set_setting <span class="token punctuation">\</span>
<span class="token assign-left variable">setting_id</span><span class="token operator">=</span><span class="token string">'8'</span> <span class="token punctuation">\</span>
<span class="token assign-left variable">state</span><span class="token operator">=</span><span class="token string">'2000'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4ktnfa:1" aria-labelledby="tab:R4ktnfa: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:R4stnfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4stnfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4stnfa:0" aria-labelledby="tab:R4stnfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="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"</span>: <span class="token string">"1500"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"This setting allows you to define the match limit of the PCRE library."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"directive"</span>: <span class="token string">"SecPcreMatchLimit"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"PCRE library match limit"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"radio_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">"name"</span>: <span class="token string">"Log all transactions."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"option"</span>: <span class="token string">"On"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"setting_id"</span>: <span class="token number">8</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token number">2000</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><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://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secpcrematchlimit">https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secpcrematchlimit</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"arg"</span>: <span class="token string">"[Ee]xample"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"startsWith"</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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_set_setting"</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/Server-Settings/operation/modsec_deploy_settings_changes" data-section-id="tag/Server-Settings/operation/modsec_deploy_settings_changes" class="sc-dntaoT ceciOs"><div data-section-id="operation/modsec_deploy_settings_changes" id="operation/modsec_deploy_settings_changes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Server-Settings/operation/modsec_deploy_settings_changes" aria-label="tag/Server-Settings/operation/modsec_deploy_settings_changes"></a>Enable staged ModSecurity configuration files<!-- --> </h2><div class="sc-fantwC dGPqXf"><div html="<p>This function deploys the staged changes to your <code>modsec2.cpanel.conf</code> file and
attempts to restart Apache. If the new settings fail validation, the system restores
the <code>/etc/apache2/conf.d/modsec/modsec2.cpanel.conf</code> file.</p>
<p><strong>Note:</strong></p>
<p>Call the WHM API 1 <code>modsec_set_setting</code> function to prepare your changes for
the <code>modsec2.cpanel.conf</code> file.</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">Web Server role</a>,
the system <strong>disables</strong> this function.</p>
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deploys the staged changes to your <code>modsec2.cpanel.conf</code> file and
attempts to restart Apache. If the new settings fail validation, the system restores
the <code>/etc/apache2/conf.d/modsec/modsec2.cpanel.conf</code> file.</p>
<p><strong>Note:</strong></p>
<p>Call the WHM API 1 <code>modsec_set_setting</code> function to prepare your changes for
the <code>modsec2.cpanel.conf</code> file.</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">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="data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">data</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-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="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">/modsec_deploy_settings_changes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>A server running WHM.</p>
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running WHM.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/json-api</span>/modsec_deploy_settings_changes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kunfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kunfa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kunfa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kunfa:1" data-rttab="true">URL</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kunfa:0" aria-labelledby="tab:R4kunfa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">whmapi1 <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
modsec_deploy_settings_changes
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kunfa:1" aria-labelledby="tab:R4kunfa: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:R4sunfa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sunfa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sunfa:0" aria-labelledby="tab:R4sunfa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token 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">"metadata"</span>: <button class="collapser" aria-label="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">"modsec_deploy_settings_changes"</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><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":"WHM API.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"WHM API","version":null,"x-logo":{"url":"images/whm-api-full.png","altText":"WebPros International, LLC"}},"servers":[{"description":"A server running WHM.","url":"https://{host}:{port}/json-api","variables":{"host":{"default":"whm-server.tld","description":"The hostname of a server running WHM."},"port":{"default":"2087","description":"The WHM port."}}}],"security":[{"BasicAuth":[]}],"tags":[{"description":"Accounts Creation / Accounts","name":"Account Creation"},{"description":"Accounts / Account Creation","name":"Account Creation"},{"description":"Resellers / Account Enhancement Limit","name":"Account Enhancement Limit"},{"description":"Accounts / Account Enhancements","name":"Account Enhancements"},{"description":"The Account Enhancement module for WHM.","name":"Account Enhancements"},{"description":"The Account Enhancements module for WHM.","name":"Account Enhancements"},{"description":"Resellers / Account Limits","name":"Account Limits"},{"description":"Accounts / Account Management","name":"Account Management"},{"description":"Resellers / Account Permissions","name":"Account Permissions"},{"description":"The Account Restoration module for WHM API 1.","name":"Account Restoration"},{"description":"Resellers / Account Settings","name":"Account Settings"},{"description":"The Account Enhancement module for WHM.","name":"AccountEnhancement"},{"description":"The Accounts module for WHM API 1.","name":"Accounts"},{"description":"Integrations / API Authentication","name":"API Authentication"},{"description":"The Server Administration module for WHM API 1.","name":"API Execution"},{"description":"API Development Tools / API Execution","name":"API Execution"},{"description":"API Development Tools / API Statistics","name":"API Statistics"},{"description":"API Development Tools / API Token Management","name":"API Token Management"},{"description":"API Development Tools / Applications","name":"Applications"},{"description":"The Authentication module for WHM API 1.","name":"Authentication"},{"description":"Authentication / Authentication Providers","name":"Authentication Providers"},{"description":"SSL Certificates / Auto-Generated Certificates","name":"Auto-Generated Certificates"},{"description":"Backups / Backup Destination","name":"Backup Destination"},{"description":"Backups / Backup or Restore","name":"Backup or Restore"},{"description":"Backups / Backup Settings","name":"Backup Settings"},{"description":"The Backups module for WHM API 1.","name":"Backups"},{"description":"Accounts / Bandwidth and Disk Quotas","name":"Bandwidth and Disk Quotas"},{"description":"Configuration Management / Leika","name":"Configuration"},{"description":"Server Administration / Configuration Clusters","name":"Configuration Clusters"},{"description":"Server Administration / Configurations","name":"Configurations"},{"description":"Server Administration / Connected Applications","name":"Connected Applications"},{"description":"Server Administration / Connections","name":"Connections"},{"description":"Mail / cPanel Account Mail Management","name":"cPanel Account Mail Management"},{"description":"SSL Certificates / cPanel Account Settings","name":"cPanel Account Settings"},{"description":"Transfers / cPanel Account Transfer","name":"cPanel Account Transfer"},{"description":"The cPanel Analytics module for WHM API 1.","name":"cPanel Analytics"},{"description":"cPCloud related WHM API 1 functions.","name":"cPCloud"},{"description":"cPCloud Service related WHM API 1 functions.","name":"cPCloud"},{"description":"The cPHulk module for WHM API 1.","name":"cPHulk"},{"description":"The Customizations module for WHM API 1.","name":"Customizations"},{"description":"The Databases module for WHM API 1.","name":"Databases"},{"description":"The DNS module for WHM API 1.","name":"DNS"},{"description":"DNS / DNS Cluster Settings","name":"DNS Cluster Settings"},{"description":"DNS / DNS Security","name":"DNS Security"},{"description":"DNS / DNS Zones","name":"DNS Zones"},{"description":"Accounts / Domain Information","name":"Domain Information"},{"description":"Accounts / Domain Domain Information","name":"Domain Information"},{"description":"DNS / Domain Management","name":"Domain Management"},{"description":"The EasyApache module for WHM API 1.","name":"EasyApache"},{"description":"Web Server Configuration / EasyApache Settings","name":"EasyApache Settings"},{"description":"Authentication / External Authentication","name":"External Authentication"},{"description":"Hosting Plans / Feature Access","name":"Feature Access"},{"description":"Hosting Plans / Feature Lists","name":"Feature Lists"},{"description":"The Greylisting module for WHM API 1.","name":"Greylisting"},{"description":"Hosting Plans / Hosting Plan Extensions","name":"Hosting Plan Extensions"},{"description":"Hosting Plans / Hosting Plans","name":"Hosting Plans"},{"description":"System Package Management / Install or Uninstall Package","name":"Install or Uninstall Package"},{"description":"The Integration module for WHM API 1.","name":"Integration"},{"description":"The IP Addresses module for WHM API 1.","name":"IP Addresses"},{"description":"IP Address Management / IPv4 Address Settings","name":"IPv4 Address Settings"},{"description":"IP Address Management / IPv6 Address Settings","name":"IPv6 Address Settings"},{"description":"Backups / Legacy Migration","name":"Legacy Migration"},{"description":"The Leika module for WHM API 1.","name":"Leika"},{"description":"Server Administration / License Management","name":"License Management"},{"description":"The Server Administration module for WHM API 1.","name":"License Management"},{"description":"Integrations / Links","name":"Links"},{"description":"System Package Management / List Package Information","name":"List Package Information"},{"description":"Authentication / Login URL","name":"Login URL"},{"description":"Logs / Web Log Retention","name":"Logs"},{"description":"The Mail module for WHM API 1.","name":"Mail"},{"description":"Mail / Mail DNS Settings","name":"Mail DNS Settings"},{"description":"Mail / Mail Server Settings","name":"Mail Server Settings"},{"description":"Databases / Manage MySQL Server","name":"Manage MySQL Server"},{"description":"Login Security (cPHulk) / Management","name":"Management"},{"description":"The Market module for WHM API 1.","name":"Market"},{"description":"Commerce Integration / Market Integration","name":"Market Integration"},{"description":"The ModSecurity module for WHM API 1.","name":"ModSecurity"},{"description":"Databases / MySQL Databases","name":"MySQL Databases"},{"description":"IP Address Management / Network Address Translation","name":"Network Address Translation"},{"description":"NFS","name":"NFS"},{"description":"The NGINX Manager module for WHM API 1.","name":"NGINX Manager"},{"description":"Server Administration / Notifications","name":"Notifications"},{"description":"System Package Management / Package Manager Settings","name":"Package Manager Settings"},{"description":"The Packages module for WHM API 1.","name":"Packages"},{"description":"Accounts / Passwords","name":"Passwords"},{"description":"The PHP module for WHM API 1.","name":"PHP"},{"description":"Web Server Configuration / PHP-FPM","name":"PHP-FPM"},{"description":"Databases / PostgreSQL Databases","name":"PostgreSQL Databases"},{"description":"cPanel Market / Product Management","name":"Product Management"},{"description":"cPanel Market / Provider Management","name":"Provider Management"},{"description":"Databases / Remote MySQL Databases","name":"Remote MySQL Databases"},{"description":"The RemoteStorage module for WHM API 1.","name":"RemoteStorage"},{"description":"RemoteStorage","name":"RemoteStorage"},{"description":"Login Security (cPHulk) / Reporting","name":"Reporting"},{"description":"Resellers / Account Management","name":"Reseller Account Management"},{"description":"The Resellers module for WHM API 1.","name":"Resellers"},{"description":"DNS / Resolvers","name":"Resolvers"},{"description":"Account Restoration / Restore Account","name":"Restore Account"},{"description":"Account Restoration / Restore Queue Management","name":"Restore Queue Management"},{"description":"Account Restoration / Restore Queue Reporting","name":"Restore Queue Reporting"},{"description":"The RPM module for WHM API 1.","name":"RPM"},{"description":"Web Server Security (ModSecurity) / Rule Settings","name":"Rule Settings"},{"description":"Web Server Security (ModSecurity) / Rule Vendor Settings","name":"Rule Vendor Settings"},{"description":"The Script Hooks module for WHM API 1.","name":"Script Hooks"},{"description":"Integrations / Scripts Hooks","name":"Scripts Hooks"},{"description":"The Security module for WHM API 1.","name":"Security"},{"description":"The Server Administration module for WHM API 1.","name":"Server Administration"},{"description":"Server Administration / Server Nodes","name":"Server Nodes"},{"description":"Server Administration / Server Profiles","name":"Server Profiles"},{"description":"Web Server Security (ModSecurity) / Server Settings","name":"Server Settings"},{"description":"Server Administration / Services","name":"Services"},{"description":"The ServicesCluster module for WHM API 1.","name":"ServicesCluster"},{"description":"ServicesCluster","name":"ServicesCluster"},{"description":"API Development Tools / Session","name":"Session"},{"description":"Login Security (cPHulk) / Settings","name":"Settings"},{"description":"Mail / Spam Management","name":"Spam Management"},{"description":"Mail / Spam Protection (Greylisting)","name":"Spam Protection (Greylisting)"},{"description":"Authentication / SSH Keys and Connections","name":"SSH Keys and Connections"},{"description":"The SSL module for WHM API 1.","name":"SSL"},{"description":"SSL Certificates / SSL Server Settings","name":"SSL Server Settings"},{"description":"The Server Administration module for WHM API 1.","name":"Styles"},{"description":"The Styles and Themes module for WHM API 1.","name":"Styles"},{"description":"Server Administration / Account Management","name":"Styles"},{"description":"cPanel Support Tickets / Support Access","name":"Support Access"},{"description":"The Support Tickets module for WHM API 1.","name":"Support Tickets"},{"description":"Accounts / Suspensions","name":"Suspensions"},{"description":"Server Administration / System Information","name":"System Information"},{"description":"The Server Administration module for WHM API 1.","name":"System Information"},{"description":"cPanel Support Tickets / Ticket Management","name":"Ticket Management"},{"description":"Transfers / Transfer Configuration","name":"Transfer Configuration"},{"description":"Transfers / Transfer Monitoring","name":"Transfer Monitoring"},{"description":"The Transfers module for WHM API 1.","name":"Transfers"},{"description":"Authentication / Two-Factor Authentication","name":"Two-Factor Authentication"},{"description":"The Updates module for WHM API 1.","name":"Updates"},{"description":"Server Administration / Updates","name":"Updates"},{"description":"The Web Log Retention module for WHM API 1.","name":"Web Log Retention"},{"description":"Security / WHM Access","name":"WHM"},{"description":"Security / WHM Access","name":"WHM Access"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"paths":{"/convert_all_domains_to_fpm":{"get":{"description":"This function activates PHP-FPM for any non-PHP-FPM domains on a server.\n\n**Important:**\n\nWhen you disable the [*Web Server*](https://go.cpanel.net/howtouseserverprofiles) role, the system **disables** this function.\n\n**Warning:**\n\nWe **strongly** recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.","operationId":"convert_all_domains_to_fpm","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"build_id":{"description":"The ID of the log file for the conversion process.","example":1493645268,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"convert_all_domains_to_fpm","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* 1 - Success\n* 0 - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable PHP-FPM on all domains","tags":["PHP-FPM"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n convert_all_domains_to_fpm\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_all_domains_to_fpm?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"66"}},"/php_fpm_config_set":{"post":{"description":"This function configures the PHP INI directives and pool options\nfor a system's or domain's PHP-FPM configuration.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.\n\n**Warning:**\n\nWe **strongly** recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or\nat least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may\nexperience severe performance issues.","operationId":"php_fpm_config_set","requestBody":{"content":{"application/json":{"schema":{"example":{"config":[{"base_flag_name":"error_reporting","trinary_admin_value":1,"value":"E_ALL & ~E_NOTICE"},{"base_flag_name":"pm_max_children","trinary_admin_value":0,"value":"10"}]},"properties":{"config":{"description":"An array of objects containing the PHP-FPM configuration values to validate or update.","items":{"properties":{"base_flag_name":{"description":"A PHP INI directive or PHP-FPM pool option name.\n\n**PHP INI directives**\n\n* `allow_url_fopen` - The PHP configuration treats URLs as files.\n* `disable_functions` - Lists the functions that the system will disable.\n* `doc_root` - The PHP pages' document root.\n* `error_log` - The error log file.\n* `error_reporting` - The errors that the system reports on.\n* `log_errors` - Whether the system will log errors.\n* `short_open_tag` - Whether the system recognizes code between the <? and ?> tags as a PHP source.\n\n**Pool options**\n\n* `pm_max_children` - The maximum number of process pools that the PHP-FPM Master Process will generate to handle requests.\n* `pm_max_requests` - The maximum number of requests that the process pools can receive.\n* `pm_process_idle_timeout` - The amount of time, in seconds, that a pool process will wait for a request.","type":"string"},"trinary_admin_value":{"description":"Whether the PHP value is a PHP INI directive value (`php_value`), a PHP INI ADMIN value (`php_admin_value`), or a PHP-FPM pool option (`pm_*`).\n\n* `0` - A PHP-FPM-specific value (pool options).\n* `1` - A PHP INI ADMIN directive. A cPanel account user **cannot** override this directive.\n* `2` - A PHP INI directive. A cPanel account user can override this directive.","enum":[0,1,2],"example":0,"type":"integer"},"value":{"description":"An argument value for `base_flag_name` parameter.","type":"string"}},"required":["base_flag_name","trinary_admin_value","value"],"type":"object"},"type":"array"},"domain":{"default":"","description":"A blank value or domain name whose PHP-FPM configuration you wish\nto set.","type":"string"},"validate_only":{"default":false,"description":"Whether the function request is for validation or to update the settings.\n* `true` - Only validate the configuration.\n* `false` - Validate and update the configuration.","type":"boolean"}},"required":["config"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_fpm_config_set","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update PHP-FPM directives and pool options","tags":["PHP-FPM"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"echo '{\"config\":[{\"base_flag_name\":\"error_reporting\",\"trinary_admin_value\":\"1\",\"value\":\"E_ALL & ~E_NOTICE\"},{\"base_flag_name\":\"pm_max_children\",\"trinary_admin_value\":\"0\",\"value\":\"10\"}]}' | \\\nwhmapi1 --input=json --output=jsonpretty \\\n php_fpm_config_set"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/json-api/php_fpm_config_set HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 197\n\n{\"api.version\":\"1\",\"config\":[{\"base_flag_name\":\"error_reporting\",\"trinary_admin_value\":\"1\",\"value\":\"E_ALL & ~E_NOTICE\"},{\"base_flag_name\":\"pm_max_children\",\"trinary_admin_value\":\"0\",\"value\":\"10\"}]}"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"78"}},"/is_conversion_in_progress":{"get":{"description":"This function indicates whether the system's process to convert all of WHM's accounts to use PHP-FPM is in progress.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.\n\n**Warning:**\n\nWe **strongly** recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.","operationId":"is_conversion_in_progress","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"inProgress":{"description":"Whether the system's process to convert all of WHM's accounts to use PHP-FPM is in progress.\n* `1` — In progress.\n* `0` — **Not** currently in progress.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"is_conversion_in_progress","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return PHP-FPM conversion status","tags":["PHP-FPM"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n is_conversion_in_progress\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/is_conversion_in_progress?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.72"}},"/php_get_handlers":{"get":{"description":"This function returns the PHP handlers on the system.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"php_get_handlers","parameters":[{"description":"An installed PHP version.\n\n* `ea-php54`\n* `ea-php55`\n* `ea-php56`\n* `ea-php70`\n* `ea-php71`\n* `ea-php72`\n* `inherit`\n* Any custom PHP package name.\n\n**Important:**\n\nWe deprecated PHP 5.6 and PHP 7.0 and will remove them in a future version.\nFor more information, read our\n[cPanel Deprecation Plan](https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-deprecation-plan/)\ndocumentation.","in":"query","name":"version","required":false,"schema":{"example":"ea-php72","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"version_handlers":{"description":"An array of objects containing the available PHP handlers.","items":{"properties":{"available_handlers":{"description":"The installed PHP handlers.\n\n* `suphp`\n* `cgi`\n* `dso`\n* `none`","example":["cgi","none","suphp"],"items":{"enum":["suphp","cgi","dso","none"],"type":"string"},"type":"array"},"current_handler":{"description":"The PHP version's handler.\n\n* `suphp`\n* `cgi`\n* `dso`\n* `none`","enum":["suphp","cgi","dso","none"],"example":"suphp","type":"string"},"version":{"description":"An installed PHP version.\n\n* `ea-php54`\n* `ea-php55`\n* `ea-php56`\n* `ea-php70`\n* `ea-php71`\n* `ea-php72`\n* `inherit`\n* Any custom PHP package name.\n\n**Important:**\n\nWe deprecated PHP 5.6 and PHP 7.0 and will remove them in a future version.\nFor more information, read our\n[cPanel Deprecation Plan](https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-deprecation-plan/)\ndocumentation.","example":"ea-php72","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_get_handlers","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return PHP handlers","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_get_handlers\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_get_handlers?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/php_get_old_fpm_flag":{"get":{"description":"This function determines whether your system runs with a preconfigured PHP-FPM configuration.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"php_get_old_fpm_flag","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"old_fpm_flag":{"description":"The status of the preconfigured FPM.\n* `0` — No preconfigured FPM exists.\n* `1` — Preconfigured FPM exists.\n* `2` — Preconfiguration dialogue dismissed.","enum":[0,1,2],"example":2,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_get_old_fpm_flag","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return PHP-FPM preconfigured status","tags":["PHP-FPM"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_get_old_fpm_flag\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_get_old_fpm_flag?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"60"}},"/php_get_impacted_domains":{"get":{"description":"This function lists domains that obtain their PHP version from a specified PHP configuration.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"php_get_impacted_domains","parameters":[{"description":"Whether to return domains that inherit the system's default PHP version.\n\n* `1` — Return domains that inherit the system's default PHP version.\n* `0` — Do **not** return domains that inherit the system's default PHP version.\n\n**Note:**\n\n* You **must** pass either the `system_default` or `domain` parameters, or both.\n* If you pass this parameter with a false value and do **not** also pass the `domain`\nparameter, the function returns an error.","in":"query","name":"system_default","required":true,"schema":{"enum":[1,0],"example":1,"type":"integer"}},{"description":"A domain on the system.\n\n**Note:**\n\n* You **must** pass either the `system_default` or `domain` parameters, or both.\n* You can pass this parameter multiple times.\n* You **cannot** pass the name of a parked domain.","examples":{"multiple":{"summary":"Pass multiple domains.","value":"domain=example.com domain=example2.com domain=example3.com"},"single":{"summary":"Pass a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"domains":{"description":"A list of domains or subdomains that obtain their PHP version from\nthe PHP configuration.\n\n**Note:**\n\nThis function does **not** return parked domains.","example":["example.com","subdomain.example.com","example2.com"],"items":{"type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_get_impacted_domains","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return PHP preconfigured domains","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_get_impacted_domains \\\n system_default='1' \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_get_impacted_domains?api.version=1&system_default=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"62"}},"/php_ini_set_content":{"post":{"description":"This function changes the contents of a PHP version's php.ini file.\n\n**Notes:**\n\n - This document **only** applies to systems that run EasyApache 4.\n - Due to the limited field length of HTTP GET method calls, we **strongly** recommend that you use the HTTP POST method.\n\n**Important:**\n When you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"php_ini_set_content","parameters":[{"description":"The contents of the `php.ini` file that you wish to change.","in":"query","name":"content","required":true,"schema":{"example":"[PHP]\n; About php.ini\n; php.ini is responsible for configuring many of the aspects of PHP's behavior.\npcre.backtrack_limit=100000\n","type":"string"}},{"description":"The version of PHP for which you wish to change the `php.ini` file.\n\n* `ea-php72`\n* `ea-php73`\n* `ea-php74`\n* `Any custom PHP package name`","in":"query","name":"version","required":true,"schema":{"example":"ea-php74","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_ini_set_content","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Ok","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update PHP version's php.ini file","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_ini_set_content \\\n content=$'[PHP]\n; About php.ini\n; php.ini is responsible for configuring many of the aspects of PHP\\'s behavior.\npcre.backtrack_limit=100000\n' \\\n version='ea-php74'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_ini_set_content?api.version=1&content=%5bPHP%5d%0a%3b%20About%20php.ini%0a%3b%20php.ini%20is%20responsible%20for%20configuring%20many%20of%20the%20aspects%20of%20PHP%27s%20behavior.%0apcre.backtrack_limit%3d100000%0a&version=ea-php74"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/php_ini_get_content":{"get":{"description":"This function returns the contents of a PHP version's `php.ini` file.\n\n**Note:**\n\n This document **only** applies to systems that run EasyApache 4.\n\n**Important:**\n\n When you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"php_ini_get_content","parameters":[{"description":"The name of an installed PHP version's package.\n - `ea-php##`, where `##` represents the major and minor versions of PHP (for example, `ea-php74` represents PHP 7.4).\n - `inherit`\n - Any custom PHP package name. ","in":"query","name":"version","required":true,"schema":{"example":"ea-php74","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"content":{"description":"The contents of the requested PHP version's `php.ini` file.","example":"display_errors; Default Value: On; Development Value: On; Production Value: Off;","type":"string"}}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_ini_get_content","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Ok","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return PHP version's php.ini file","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_ini_get_content \\\n version='ea-php74'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_ini_get_content?api.version=1&version=ea-php74"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/php_set_default_accounts_to_fpm":{"get":{"description":"This function determines whether to enable PHP-FPM on new accounts and domains on a server.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.\n\n**Warning:**\n\nWe **strongly** recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.","operationId":"php_set_default_accounts_to_fpm","parameters":[{"description":"Whether to enable PHP-FPM on all new accounts and domains on\na server.\n* `1` — Enable PHP-FPM.\n* `0` — Disable PHP-FPM.","in":"query","name":"default_accounts_to_fpm","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_set_default_accounts_to_fpm","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable PHP-FPM on new cPanel accounts and domains","tags":["PHP-FPM"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_set_default_accounts_to_fpm \\\n default_accounts_to_fpm='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_set_default_accounts_to_fpm?api.version=1&default_accounts_to_fpm=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"66"}},"/php_set_old_fpm_flag":{"get":{"description":"This function creates the `/etc/cpanel/ea4/old_fpm_flag` touch file.\n\n**Note:**\n\nIf this touch file exists, the system will **not** display a message that indicates whether your system runs on an outdated PHP-FPM configuration. If you wish to see the message again, delete this touch file.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"php_set_old_fpm_flag","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"success":{"description":"Whether the operation succeeds.\n* `1` — Success.\n* `0` — Failure.","enum":[0,1],"example":0,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_set_old_fpm_flag","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable PHP-FPM preconfigured status","tags":["PHP-FPM"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_set_old_fpm_flag\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_set_old_fpm_flag?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"60"}},"/php_set_system_default_version":{"get":{"description":"The version of PHP that you wish to set as the system's default.\n\n* `ea-php81`\n* `inherit`\n* Any custom PHP package name.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"php_set_system_default_version","parameters":[{"description":"The version of PHP that you wish to set as the system's default.","in":"query","name":"version","required":true,"schema":{"example":"ea-php81","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_set_system_default_version","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Ok","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update default PHP version","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_set_system_default_version \\\n version='ea-php74'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_set_system_default_version?api.version=1&version=ea-php74"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/php_get_vhost_versions":{"get":{"description":"This function returns the PHP version of every virtual host that a reseller controls.\n\n**Note:**\n\n This document **only** applies to systems that run EasyApache 4.\n\n**Important:**\n\n When you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"php_get_vhost_versions","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"versions":{"description":"An array of objects containing the virtual host's suspendend status, versions, virtual hosts, and accounts.","items":{"properties":{"account":{"description":"The account's name.","example":"rm3","format":"username","type":"string"},"account_owner":{"description":"The account owner's name.","example":"root","format":"username","type":"string"},"documentroot":{"description":"The virtual host's document root.","example":"/home/example/public_html","type":"string"},"homedir":{"description":"The virtual host's home directory.","example":"/home/rm3","type":"string"},"is_suspended":{"description":"The virtual host's suspension status.\n\n**Note:**\n\n* `1` - Suspended\n* `0` - **Not** suspended.","enum":[1,0],"example":0,"type":"integer"},"main_domain":{"description":"Whether the virtual host is the primary domain.\n\n**Note:**\n\n* `1` - The primary domain\n* `0` - **Not** the primary domain","enum":[1,0],"example":1,"type":"integer"},"php_fpm":{"description":"Whether PHP-FPM is enabled.\n\n* `1` - PHP-FPM enabled.\n* `0` - PHP-FPM **not** enabled.","enum":[1,0],"example":1,"type":"integer"},"php_fpm_pool_parms":{"description":"Object containing the domain's PHP-FPM parameters.","properties":{"pm_max_children":{"description":"The maximum number of child pages per pool.","example":5,"minimum":1,"type":"integer"},"pm_max_requests":{"description":"The number of possible requests the system allows.","example":20,"minimum":1,"type":"integer"},"pm_process_idle_timeout":{"description":"How long the system remains idle before it kills the FPM child process.","example":10,"minimum":1,"type":"integer"}},"type":"object"},"phpversion_source":{"description":"How the virtual host determines its PHP version.","items":{"properties":{"domain":{"description":"The domain the virtual host inherits its PHP version from.","example":"example.com","format":"domain","type":"string"},"system_default":{"description":"Whether the virtual host uses the system's default PHP version.\n* `1` - Uses the system default PHP version.\n\n**Note:**\n\n The function **only** returns this value if true.","enum":[1],"example":1,"type":"integer"}},"type":"object"},"properties":{"system_default":{}},"type":"array"},"version":{"description":"The virtual host's PHP version.\n\n* `ea-php72`\n* `ea-php73`\n* `ea-php74`\n* `inherit`\n* Any custom PHP package name.","example":"ea-php72","type":"string"},"vhost":{"description":"The virtual host's name.","example":"otherchars.rm3.tld","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_get_vhost_versions","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return PHP version of all virtual hosts","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_get_vhost_versions\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_get_vhost_versions?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"60"}},"/php_set_session_save_path":{"get":{"description":"This function sets the location of PHP's default session save path.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"php_set_session_save_path","parameters":[{"description":"The directory in which to save session information.\n\n**Warning:**\n\nFor security reasons, do **not** set this value to `/tmp` or another insecure location.","in":"query","name":"path","required":false,"schema":{"default":"/var/cpanel/php/sessions","example":"/var/cpanel/php/sessions","type":"string"}},{"description":"Whether to overwrite the existing session save path in the `php.ini`\nfile.\n* `1` — Overwrite the existing value in the `php.ini` file.\n* `0` — Do **not** overwrite the existing value in the `php.ini` file.","in":"query","name":"overwrite","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_set_session_save_path","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update PHP default save path","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_set_session_save_path\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_set_session_save_path?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"66"}},"/get_fpm_count_and_utilization":{"get":{"description":"This function provides information that will help you to determine\nwhether your server can handle the workload if you enable PHP-FPM for all domains.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://go.cpanel.net/howtouseserverprofiles),\nthe system **disables** this function.\n\n**Warning:**\n\nWe **strongly** recommend that you only activate Apache PHP-FPM if your server\nhas at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable\nPHP-FPM on a server with less than the required RAM, your server may experience severe\nperformance issues.","operationId":"get_fpm_count_and_utilization","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"domains_to_be_enabled":{"description":"The number of domains that you will enable with PHP-FPM when you run the `/scripts/php_fpm_config_convert` script.","example":2,"minimum":0,"type":"integer"},"domains_using_fpm":{"description":"The number of domains with PHP-FPM enabled.","example":20,"minimum":0,"type":"integer"},"memory_needed":{"description":"The approximate number of megabytes of memory that your system will require to convert the remaining domains to PHP-FPM.","example":90000,"format":"megabytes","minimum":0,"type":"integer"},"number_of_new_fpm_accounts_we_can_handle":{"description":"The approximate number of domains on which you can enable PHP-FPM without a server overload.","example":8,"minimum":0,"type":"integer"},"show_warning":{"description":"Whether you **may** overload your server when you convert all domains\nto PHP-FPM.\n\n* `1` — **High** risk of server overload when you enable PHP-FPM.\n* `0` — **Low** risk of server overload when you enable PHP-FPM.","enum":[1,0],"example":0,"type":"integer"},"total_domains":{"description":"The total number of domains on the server.","example":22,"minimum":0,"type":"integer"}}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_fpm_count_and_utilization","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return workload data for PHP-FPM on all domains","tags":["PHP-FPM"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_fpm_count_and_utilization\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_fpm_count_and_utilization?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"66"}},"/php_get_installed_versions":{"get":{"description":"This function returns the installed PHP versions on a server.\n\n**Note:**\n\n This document **only** applies to systems that run EasyApache 4.\n\n**Important:**\n\n When you disable the [Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles) , the system **disables** this function.","operationId":"php_get_installed_versions","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"versions":{"description":"The installed PHP versions.\n\n- ea-php71\n- ea-php72\n- ea-php73\n- ea-php74\n- Any custom PHP package name.","items":{"example":"ea-php74","type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_get_installed_versions","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Ok","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return installed PHP versions","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_get_installed_versions\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_get_installed_versions?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/php_set_vhost_versions":{"get":{"description":"This function allows WHM's\n[*MultiPHP Manager*](https://docs.cpanel.net/whm/software/multiphp-manager-for-whm/)\ninterface (*WHM >> Home >> Software >> MultiPHP Manager*) to change the values of a domain.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.\n\n**Warning:**\n\nWe **strongly** recommend that you only activate Apache PHP-FPM if your server has at\nleast 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM\non a server with **less** than the required RAM, your server may experience severe\nperformance issues.","operationId":"php_set_vhost_versions","parameters":[{"content":{"application/json":{"schema":{"example":{"pm_max_children":5,"pm_max_requests":20,"pm_process_idle_timeout":10},"format":"json","properties":{"pm_max_children":{"default":5,"description":"The maximum number of child pages per pool.","example":5,"type":"integer"},"pm_max_requests":{"default":20,"description":"The maximum number of requests per pool.","example":20,"type":"integer"},"pm_process_idle_timeout":{"default":10,"description":"A specified time of idleness before the system kills an FPM child page.","example":10,"type":"integer"}},"required":["pm_max_children","pm_process_idle_timeout","pm_max_requests"],"type":"object"}}},"description":"A JSON-encoded string containing a hash of values.","in":"query","name":"php_fpm_pool_parms","required":false},{"description":"Whether PHP-FPM is enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","in":"query","name":"php_fpm","required":false,"schema":{"default":0,"enum":[1,0],"example":1,"type":"integer"}},{"description":"The virtual host's (vhost) PHP version.\n\n**Note:**\n\nThis parameter also accepts any custom PHP package names.","in":"query","name":"version","required":true,"schema":{"enum":["ea-php54","ea-php55","ea-php56","ea-php70","ea-php71","ea-php72","inherit"],"example":"ea-php70","type":"string"}},{"description":"The virtual host's name.\n\n**Note:**\n\nTo set multiple vhosts, increment the parameter name. For example, `vhost-1`, `vhost-2`,\nand `vhost-3`.","examples":{"multiple":{"summary":"Set multiple vhosts.","value":"vhost-1=otherchars.rm3.tld vhost-2=morechars.rm3.tld vhost-3=lotschars.rm3.tld"},"single":{"summary":"Set a single vhost.","value":"otherchars.rm3.tld"}},"in":"query","name":"vhost","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_set_vhost_versions","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update domain's PHP values","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_set_vhost_versions \\\n version='ea-php70' \\\n vhost='otherchars.rm3.tld'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_set_vhost_versions?api.version=1&version=ea-php70&vhost=otherchars.rm3.tld"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"60"}},"/php_fpm_config_get":{"post":{"description":"This function retrieves the PHP INI directives and pool options for a system's or domain's PHP-FPM configuration.\n\n **Important:**\n\n When you disable the [WebServer role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.\n\n **Warning:**\n\n We **strongly** recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.","operationId":"php_fpm_config_get","requestBody":{"content":{"application/json":{"schema":{"properties":{"domain":{"default":"","description":"A blank value or domain name whose PHP-FPM configuration you wish to retrieve.\n\n* A valid domain that resides on the local server — Retrieves the domain's PHP-FPM configuration information.\n* A blank value — Retrieves the system's PHP-FPM information.","example":"example.com","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"config":{"description":"An array of objects that contains the PHP-FPM configuration values.","example":[{"base_flag_name":"short_open_tag","trinary_admin_value":1,"value":"on"},{"base_flag_name":"log_errors","trinary_admin_value":1,"value":"on"},{"base_flag_name":"pm_process_idle_timeout","trinary_admin_value":0,"value":"10"},{"base_flag_name":"error_reporting","trinary_admin_value":2,"value":"E_ALL & ~E_NOTICE"},{"base_flag_name":"disable_functions","trinary_admin_value":1,"value":"exec,passthru,shell_exec,system"},{"base_flag_name":"error_log","trinary_admin_value":1,"value":"[% homedir %]/logs/[% scrubbed_domain %].php.error.log"},{"base_flag_name":"pm_max_children","trinary_admin_value":0,"value":"5"},{"base_flag_name":"pm_max_requests","trinary_admin_value":0,"value":"20"},{"base_flag_name":"allow_url_fopen","trinary_admin_value":1,"value":"on"},{"base_flag_name":"doc_root","trinary_admin_value":1,"value":"[% documentroot %]"}],"items":{"properties":{"base_flag_name":{"description":"PHP INI directive or PHP-FPM pool option name.\n\n**PHP INI directives**\n\n* `allow_url_fopen` - Treat URLs as files.\n* `disable_functions` - Lists the functions that the system will disable.\n* `doc_root` - The PHP pages' document root.\n* `error_log` - The error log file.\n* `error_reporting` - The errors that the system reports on.\n* `log_errors` - Whether the system will log errors.\n* `short_open_tag` - Whether the system recognizes code between the <? and ?> tags as a PHP source. Pool options- pm_max_children The maximum number of process pools that the PHP-FPM Master Process will generate to handle requests.\n\n**Pool options**\n\n* `pm_max_children` — The maximum number of process pools that the PHP-FPM Master Process will generate to handle requests.\n* `pm_max_requests` - The maximum number of requests that the process pools can receive.\n* `pm_process_idle_timeout` - The amount of time, in seconds, that a pool process will wait for a request.","example":"pm_max_children","type":"string"},"trinary_admin_value":{"description":"Whether the PHP value is a PHP INI directive value (`php_value`), a PHP INI ADMIN value (`php_admin_value`), or a PHP-FPM pool option (`pm_*`).\n\n* `0` - A PHP-FPM-specific value (pool options).\n* `1` - A PHP INI ADMIN directive. A cPanel account user **cannot** override this directive.\n* `2` - A PHP INI directive. A cPanel account user can override this directive.","enum":[0,1,2],"example":0,"type":"integer"},"value":{"description":"An argument value for `base_flag_name`.","example":"5","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_fpm_config_get","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return PHP-FPM directives and pool options","tags":["PHP-FPM"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"echo '{\"domain\":\"example.com\"}' | \\\nwhmapi1 --input=json --output=jsonpretty \\\n php_fpm_config_get"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/json-api/php_fpm_config_get HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 42\n\n{\"api.version\":\"1\",\"domain\":\"example.com\"}"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"78"}},"/php_get_system_default_version":{"get":{"description":"This function returns the system default PHP version.\n\n**Note:**\n\nThis document **only** applies to systems that run EasyApache 4.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"php_get_system_default_version","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"version":{"description":"The server's default PHP version.\n* `ea-php##`, where `##` represents the major and minor versions of PHP (for example, `ea-php72` represents PHP 7.2).\n* `inherit`\n* Any custom PHP package name.","example":"ea-php56","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_get_system_default_version","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Ok","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return system default PHP version","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_get_system_default_version\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_get_system_default_version?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/php_ini_set_directives":{"get":{"description":"This function sets the value of a PHP version's directives.\n\n**Note:**\n\n This document only applies to systems that run EasyApache 4.\n\n**Important:**\n\n When you disable the [Web Server](https://go.cpanel.net/serverroles) role , the system **disables** this function.","operationId":"php_ini_set_directives","parameters":[{"description":"The name of a PHP directive and its value.\n\n**Note:**\n\n To change the directive's value for multiple PHP directives, duplicate or increment the parameter name. For example, to change three directives, use the directive parameter multiple times or use the `directive-1`, `directive-2` , and `directive-3` parameters.","examples":{"multiple":{"summary":"Set the values for multiple directives.","value":"directive-1=allow_url_fopen:0&directive-2=max_input_vars=1000"},"single":{"summary":"Set the value for a single directive.","value":"allow_url_fopen:0"}},"in":"query","name":"directive","required":true,"schema":{"type":"string"}},{"description":"PHP version on the system.\n\n**Note**\n\n* `ea-php56`\n* `ea-php70`\n* `ea-php71`\n* `ea-php72`\n* Any custom PHP package name.","in":"query","name":"version","required":true,"schema":{"example":"ea-php72","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"example":{},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_ini_set_directives","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Ok","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update PHP version's directives","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_ini_set_directives \\\n directive='allow_url_fopen:0' \\\n version='ea-php72'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_ini_set_directives?api.version=1&directive=allow_url_fopen%3a0&version=ea-php72"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/php_ini_get_directives":{"get":{"description":"This function returns the directives in the selected PHP version's php.ini file. WHM's [*MultiPHP INI Editor*](https://go.cpanel.net/WHMMultiPHPINI) interface (*Home >> Software >> MultiPHP INI Editor*) lists these directives in the *Basic Mode* section.\n\n**Important:**\n\n When you disable the [Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"php_ini_get_directives","parameters":[{"description":"The name of an installed version of PHP.\n\n* `ea-php72`\n* `ea-php73`\n* `ea-php74`\n* Any custom PHP package name","in":"query","name":"version","required":true,"schema":{"example":"ea-php74","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"directives":{"description":"An array of directives that are available in the `php.ini` file of the selected version of PHP.","items":{"properties":{"default_value":{"description":"The directive's default value.","example":"1","type":"string"},"info":{"description":"The purpose of the directive.","example":"This option enables the URL-aware fopen wrappers that enable accessing URL object like files. Default wrappers are provided for the access of remote files using the ftp or http protocol, some extensions like zlib may register additional wrappers.","type":"string"},"key":{"description":"The directive's name.","example":"allow_url_fopen","type":"string"},"php_ini_mode":{"description":"The directive's [PHP_INI mode](http://php.net/manual/en/configuration.changes.modes.php).\n\n* `PHP_INI_SYSTEM`\n* `PHP_INI_PERDIR`\n* `PHP_INI_ALL`\n* `PHPINI_ONLY`","example":"PHP_INI_SYSTEM","type":"string"},"type":{"description":"The type of value that the directive uses.\n* `string`\n* `boolean`\n* `integer`\n* `float`","enum":["string","boolean","integer","float"],"example":"boolean","type":"string"},"value":{"description":"The directive's current value.","example":"On","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_ini_get_directives","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Ok","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return PHP version's directives","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_ini_get_directives \\\n version='ea-php74'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_ini_get_directives?api.version=1&version=ea-php74"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/php_set_handler":{"get":{"description":"This function sets a PHP version's handler.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"php_set_handler","parameters":[{"description":"An installed PHP version.\n* `ea-php54`\n* `ea-php55`\n* `ea-php56`\n* `ea-php70`\n* `ea-php71`\n* `ea-php72`\n* `inherit`\n* Any custom PHP package name.","in":"query","name":"version","required":true,"schema":{"example":"ea-php70","type":"string"}},{"description":"An installed PHP handler.\n* `cgi`\n* `suphp`\n* `dso`\n* `none`","in":"query","name":"handler","required":true,"schema":{"enum":["cgi","suphp","dso","none"],"example":"suphp","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_set_handler","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update PHP version's handler","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_set_handler \\\n version='ea-php70' \\\n handler='suphp'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_set_handler?api.version=1&version=ea-php70&handler=suphp"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/list_accounts_retention":{"get":{"description":"List each cPanel account's web server log retention preference alongside the server default.","operationId":"list_accounts_retention","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"default_retention":{"description":"The server-wide default web log retention period, in days, from Tweak Settings.\nA value of 0 means logs are retained indefinitely.\n","example":14,"type":"integer"},"accounts":{"description":"A list of cPanel accounts and their web log retention preferences.","items":{"properties":{"user":{"description":"The cPanel account username.","example":"alice","type":"string"},"domain":{"description":"The account's primary domain.","example":"example.com","type":"string"},"retention_days":{"description":"The account's custom web log retention period, in days.\nNull when the account uses the server default.\n","example":30,"nullable":true,"type":"integer"},"using_default":{"description":"Whether the account uses the server-wide default retention setting.\n* `true` — Uses the server default.\n* `false` — Uses a custom retention value.\n","example":false,"type":"boolean"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_accounts_retention","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.\n","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"List accounts' web log retention settings","tags":["Web Log Retention","Logs"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_accounts_retention\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_accounts_retention?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"136"}},"/unsuspend_outgoing_email":{"get":{"description":"This function unsuspends outgoing email for a cPanel account's users.","operationId":"unsuspend_outgoing_email","parameters":[{"description":"The cPanel account.","in":"query","name":"user","required":true,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"unsuspend_outgoing_email","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Unsuspend account outgoing email","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n unsuspend_outgoing_email \\\n user='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/unsuspend_outgoing_email?api.version=1&user=example"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/verify_user_has_feature":{"get":{"description":"This function checks whether a user has access to a feature on a [feature list](https://go.cpanel.net/whmdocsFeatureManager).","operationId":"verify_user_has_feature","parameters":[{"description":"The cPanel account username.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The feature's ID.\n\n**Note:**\n\nCall WHM API 1's `get_feature_names` function to view available features.","in":"query","name":"feature","required":true,"schema":{"example":"sslinstall","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"has_feature":{"description":"Whether the user can access the feature.\n\n* `1` — The user can access the feature.\n* `0` — The user **cannot** access the feature.\n\n**Note:**\n\nThis function returns a `1` value for any feature that does **not** exist in\na [feature list](https://go.cpanel.net/whmdocsFeatureManager). This is because\nthe system presumes users have access to features that exist outside of the\nsystem's feature lists.","enum":[0,1],"example":1,"type":"integer"},"query_feature":{"description":"The queried feature's ID.","example":"sslinstall","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"verify_user_has_feature","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account feature access","tags":["Packages","Feature Access"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n verify_user_has_feature \\\n user='username' \\\n feature='sslinstall'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/verify_user_has_feature?api.version=1&user=username&feature=sslinstall"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/get_service_config_key":{"get":{"description":"This function returns a specific configuration key for a service.","operationId":"get_service_config_key","parameters":[{"description":"The service's name.","in":"query","name":"service","required":true,"schema":{"example":"dovecot","type":"string"}},{"description":"The configuration key's name.","in":"query","name":"key","required":true,"schema":{"example":"mail_process_size","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"key name":{"description":"configuration key's current setting.\n\n**Note:**\n\n This return's name is the value that you pass in this function's key parameter. A valid setting.","example":"512","type":"string"},"mail_process_size":{}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_service_config_key","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return service configuration key","tags":["Server Administration","Services"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_service_config_key \\\n service='dovecot' \\\n key='mail_process_size'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_service_config_key?api.version=1&service=dovecot&key=mail_process_size"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/php_get_vhosts_by_version":{"get":{"description":"This function lists the virtual hosts that use a specified version of PHP.\n\n**Note:**\n\nThis document only applies to systems that run EasyApache 4.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"php_get_vhosts_by_version","parameters":[{"description":"The name of an installed PHP package.\n- `ea-php##`, where `##` represents the major and minor versions of PHP (for example, `ea-php72` represents PHP 7.2).\n- `inherit`\n- Any custom PHP package name.","in":"query","name":"version","required":true,"schema":{"example":"ea-php56","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"vhosts":{"description":"An array of the virtual hosts that use the specified PHP version.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_get_vhosts_by_version","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return virtual hosts per PHP version","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_get_vhosts_by_version \\\n version='ea-php56'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_get_vhosts_by_version?api.version=1&version=ea-php56"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"62"}},"/set_service_config_key":{"get":{"description":"This function configures global properties for specific services listed in the `/var/cpanel/conf` directory.","operationId":"set_service_config_key","parameters":[{"description":"The service's name.\n\n* A list of service names exists in the `/var/cpanel/conf` directory.","in":"query","name":"service","required":true,"schema":{"example":"dovecot","type":"string"}},{"description":"The configuration key's name.\n\n* This parameter uses the key names listed in the `/var/cpanel/conf/{service}/main` file, where {service} is the service's name from the service parameter.\n* This function does not support subkeys.","in":"query","name":"key","required":true,"schema":{"example":"mail_process_size","type":"string"}},{"description":"The new value for the configuration key.","in":"query","name":"value","required":true,"schema":{"example":"512","oneOf":[{"type":"string"},{"type":"integer"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_service_config_key","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Succeeded","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update service configuration key","tags":["Server Administration","Services"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_service_config_key \\\n service='dovecot' \\\n key='mail_process_size' \\\n value='512'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_service_config_key?api.version=1&service=dovecot&key=mail_process_size&value=512"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/participate_in_analytics":{"get":{"description":"This function enables or disables\n[Interface Analytics](https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-analytics-the-data-we-use/#interface-analytics).","operationId":"participate_in_analytics","parameters":[{"description":"Whether to enable Interface Analytics.\n\n* `1` — Enable.\n* `0` — Disable.","in":"query","name":"enabled","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"participate_in_analytics","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable analytics data gathering","tags":["cPanel Analytics"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n participate_in_analytics \\\n enabled='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/participate_in_analytics?api.version=1&enabled=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"78"}},"/php_get_default_accounts_to_fpm":{"get":{"description":"This function determines whether the system enables PHP-FPM for new domains and accounts.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://go.cpanel.net/serverroles),\nthe system **disables** this function.\n\n**Warning:**\n\nWe **strongly** recommend that you only activate Apache PHP-FPM if your server has at\nleast 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM\non a server with less than the required RAM, your server may experience severe performance\nissues.","operationId":"php_get_default_accounts_to_fpm","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"default_accounts_to_fpm":{"description":"Whether PHP-FPM is enabled for a server's new accounts and domains.\n* `1` — PHP-FPM enabled.\n* `0` — PHP-FPM disabled.","enum":[1,0],"example":0,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"php_get_default_accounts_to_fpm","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return PHP-FPM status on new accounts","tags":["PHP-FPM"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n php_get_default_accounts_to_fpm\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/php_get_default_accounts_to_fpm?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"66"}},"/installed_versions":{"get":{"description":"This function lists the versions of third-party software that ship with cPanel & WHM.","operationId":"installed_versions","parameters":[{"description":"Whether to list the server's installed RPMs in the function's\n`cpanel_packages`, `ea_4_packages`, and `os_packages` arrays.\n\n* `1` - List.\n* `0` - Do **not** list.","in":"query","name":"packages","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"example":{"apache":"2.4.12","apache_php_default_version":0,"apache_php_versions":[0],"bind":"9.9.4-29","clamav":"0.99.2-1","cpanel_and_whm":"11.64.0.9999","cpanel_packages":["cpanel-ace-editor-1.2.6-1.cp1166.noarch","cpanel-yui-2.9.0-5.cp1136.noarch"],"cpanel_php":"7.2.7-4","cron":0,"cronie":"1.4.11-23","dovecot":"2.2.31 (65cde28)","ea_4_packages":[],"easyapache":"4","exim":"4.89-2","linux_kernel":"3.10.0-327.18.2.el7.x86_64","mailman":"2.1.23-9","mariadb":0,"mariadb_build":0,"munin":0,"mysql":"5.7.61","mysql_build":"5.7.61-1","nscd":"2.17-222","openssh-server":"7.4p1-21","operating_system_name":"centos","operating_system_version":"7.2","os_packages":["ImageMagick-6.7.8.9-15.el7_2.x86_64","zsh-5.0.2-14.el7.x86_64"],"p0f":"3.09b-1","postgresql":0,"postgresql_build":0,"powerdns":0,"proftpd":0,"pureftpd":"1.0.45","roundcube":"1.2.4-1","rsyslog":"8.24.0-16","spamd":"3.4.2","squirrelmail":0},"properties":{"apache":{"description":"The Apache® version.\n\n* `0` - Apache is **not** installed on the server.","example":"2.4.12","oneOf":[{"description":"A version of Apache.","type":"string"},{"description":"Apache is **not** installed.","enum":[0],"type":"integer"}]},"apache_php_default_version":{"description":"The default PHP version for Apache.\n\n* `0` - PHP for Apache is **not** installed on the server.","example":"7.3.21-1.1.1","oneOf":[{"description":"A version for Apache of default PHP.","type":"string"},{"description":"default PHP is **not** installed.","enum":[0],"type":"integer"}]},"apache_php_versions":{"description":"An array of PHP versions that the system installs for Apache.\n\nIf PHP for Apache is **not** installed, this will return an array containing `0`.\n\n**Note:**\n\nUnlike other keys in this object, this returns a `[0]` value when PHP for Apache is **not** installed.","example":["7.1.33-3.4.2","7.2.33-1.1.1","7.3.21-1.1.1"],"items":{"oneOf":[{"description":"A version of PHP for Apache.","type":"string"},{"description":"PHP for Apache is **not** installed on the server.","enum":[0],"type":"integer"}]},"type":"array"},"bind":{"description":"The BIND version.\n\n* `0` - BIND is **not** installed on the server.","example":"9.9.4-29","oneOf":[{"description":"A version of BIND.","type":"string"},{"description":"BIND is **not** installed.","enum":[0],"type":"integer"}]},"clamav":{"description":"The ClamAV version.\n\n* `0` - ClamAV is **not** installed on the server.","example":"0.99.2-1","oneOf":[{"description":"A version of ClamAV.","type":"string"},{"description":"ClamAV is **not** installed.","enum":[0],"type":"integer"}]},"cpanel_and_whm":{"description":"The cPanel & WHM version.","example":"11.64.0.9999","type":"string"},"cpanel_packages":{"description":"An array of cPanel-provided RPMs.\n\n**Note:**\n\nThe function **only** returns this array if you set the `packages` parameter to `1`.","example":["cpanel-ace-editor-1.1.9-1.cp1152.noarch","cpanel-analog-6.0-2.cp1136.x86_64","cpanel-angular-chosen-1.4.0-1.cp1158.noarch"],"items":{"type":"string"},"type":"array"},"cpanel_php":{"description":"The system PHP version.\n\n* `0` - System PHP is **not** installed on the server.","example":"7.2.7-4","oneOf":[{"description":"A version of cPanel & WHM.","type":"string"},{"description":"cPanel & WHM is **not** installed.","enum":[0],"type":"integer"}]},"cron":{"description":"The version of the ISC / Vixie cron daemon. This is the default cron service installed on Ubuntu.\n\n* `0` - ISC / Vixie cron is **not** installed on the server.","example":"3.0pl1-136ubuntu1","oneOf":[{"description":"A version of the cron daemon.","type":"string"},{"description":"ISC / Vixie cron is **not** installed.","enum":[0],"type":"integer"}]},"cronie":{"description":"The version of the cronie cron daemon. This is the default cron service installed on CentOS, CloudLinux, AlmaLinux, and other systems running derivatives of Red Hat Enterprise Linux.\n\n* `0` - cronie is **not** installed on the server.","example":"1.4.11-23","oneOf":[{"description":"A version of the cron daemon.","type":"string"},{"description":"cronie is **not** installed.","enum":[0],"type":"integer"}]},"dovecot":{"description":"The Dovecot version.\n\n* `0` - Dovecot is **not** installed on the server.","example":"2.2.31 (65cde28)","oneOf":[{"description":"A version of Dovecot.","type":"string"},{"description":"Dovecot is **not** installed.","enum":[0],"type":"integer"}]},"ea_4_packages":{"description":"An array of EasyApache 4 (EA4)-provided RPMs.\n\n**Note:**\n\nThe function **only** returns this array if you set the `packages` parameter to `1`.","example":[],"items":{"type":"string"},"type":"array"},"easyapache":{"description":"The EasyApache version.\n\n* `0` - EasyApache is **not** installed on the server.","example":"4","oneOf":[{"description":"A version of EasyApache.","type":"string"},{"description":"EasyApache is **not** installed.","enum":[0],"type":"integer"}]},"exim":{"description":"The Exim version.\n\n* `0` - Exim is **not** installed on the server.","example":"4.89-2","oneOf":[{"description":"A version of Exim.","type":"string"},{"description":"Exim is **not** installed.","enum":[0],"type":"integer"}]},"linux_kernel":{"description":"The Linux® kernel version.","example":"3.10.0-327.18.2.e17.x86_64","type":"string"},"mailman":{"description":"The Mailman version.\n\n* `0` - Mailman is **not** installed on the server.","example":"2.1.23-9","oneOf":[{"description":"A version of Mailman.","type":"string"},{"description":"Mailman is **not** installed.","enum":[0],"type":"integer"}]},"mariadb":{"description":"The MariaDB® version number.\n\n* `0` - MariaDB is **not** installed on the server.","example":"5.5.65","oneOf":[{"description":"A version number of MariaDB.","type":"string"},{"description":"MariaDB is **not** installed.","enum":[0],"type":"integer"}]},"mariadb_build":{"description":"The MariaDB RPM's version number.\n\n* `0` - MariaDB RPM's is **not** installed on the server.","example":"5.5.65-1","oneOf":[{"description":"A version number of MariaDB RPM's.","type":"string"},{"description":"MariaDB RPM's is **not** installed.","enum":[0],"type":"integer"}]},"munin":{"description":"The Munin version.\n\n* `0` - Munin is **not** installed on the server.","example":"2.0.30","oneOf":[{"description":"A version of Munin.","type":"string"},{"description":"Munin is **not** installed.","enum":[0],"type":"integer"}]},"mysql":{"description":"The MySQL® version number.\n\n* `0` - MySQL is **not** installed on the server.","example":"5.7.61","oneOf":[{"description":"A version number of MySQL.","type":"string"},{"description":"MySQL is **not** installed.","enum":[0],"type":"integer"}]},"mysql_build":{"description":"The MySQL RPM's version number.\n\n* `0` - MySQL RPM's is **not** installed on the server.","example":"5.7.61-1","oneOf":[{"description":"A version number of MySQL RPM's.","type":"string"},{"description":"MySQL RPM's is **not** installed.","enum":[0],"type":"integer"}]},"nscd":{"description":"The Name Service Cache Daemon version number.\n\n* `0` - Name Service Cache Daemon is **not** installed on the server.","example":"2.17-222","oneOf":[{"description":"A version number of Name Service Cache Daemon.","type":"string"},{"description":"Name Service Cache Daemon is **not** installed.","enum":[0],"type":"integer"}]},"openssh-server":{"description":"The OpenSSH version.\n\n* `0` - OpenSSH is **not** installed on the server.","example":"clients-6.6.1p1-25","oneOf":[{"description":"A version of OpenSSH.","type":"string"},{"description":"OpenSSH is **not** installed.","enum":[0],"type":"integer"}]},"operating_system_name":{"description":"The server's operating system (OS).","example":"centos","type":"string"},"operating_system_version":{"description":"The version of the server's OS.","example":"7.2","type":"string"},"os_packages":{"description":"An array of OS-provided RPMs.\n\n**Note:**\n\n The function **only** returns this array if you set the `packages` parameter to `1`.","example":["GeoIP-1.5.0-11.el7.x86_64","ImageMagick-6.7.8.9-15.el7_2.x86_64","ModemManager-glib-1.6.0-2.el7.x86_64"],"items":{"type":"string"},"type":"array"},"p0f":{"description":"The Passive OS Fingerprinting version number.\n\n* `0` - Passive OS Fingerprinting is **not** installed on the server.","example":"3.09b-1","oneOf":[{"description":"A version number of Passive OS Fingerprinting.","type":"string"},{"description":"Passive OS Fingerprinting is **not** installed.","enum":[0],"type":"integer"}]},"postgresql":{"description":"The PostgreSQL® version.\n\n* `0` - PostgreSQL is **not** installed on the server.","example":"9.2","oneOf":[{"description":"A version of PostgreSQL.","type":"string"},{"description":"PostgreSQL is **not** installed.","enum":[0],"type":"integer"}]},"postgresql_build":{"description":"The PostgreSQL RPM's version number.\n\n* `0` - PostgreSQL RPM's is **not** installed on the server.","example":"0","oneOf":[{"description":"A version number of PostgreSQL RPM's.","type":"string"},{"description":"PostgreSQL RPM's is **not** installed.","enum":[0],"type":"integer"}]},"powerdns":{"description":"The PowerDNS version.\n\n* `0` - PowerDNS is **not** installed on the server.","example":"4.1.10-15","oneOf":[{"description":"A version of PowerDNS.","type":"string"},{"description":"PowerDNS is **not** installed.","enum":[0],"type":"integer"}]},"proftpd":{"description":"The ProFTP version.\n\n* `0` - ProFTP is **not** installed on the server.","example":"1.3.7d","oneOf":[{"description":"A version of ProFTP.","type":"string"},{"description":"ProFTP is **not** installed.","enum":[0],"type":"integer"}]},"pureftpd":{"description":"The Pure-FTPd version.\n\n* `0` - Pure-FTPd is **not** installed on the server.","example":"1.0.45","oneOf":[{"description":"A version of Pure-FTPd.","type":"string"},{"description":"Pure-FTPd is **not** installed.","enum":[0],"type":"integer"}]},"roundcube":{"description":"The Roundcube version.\n\n* `0` - Roundcube is **not** installed on the server.","example":"1.2.4-1","oneOf":[{"description":"A version of Roundcube.","type":"string"},{"description":"Roundcube is **not** installed.","enum":[0],"type":"integer"}]},"rsyslog":{"description":"The Rsyslog version number.\n\n* `0` - Rsyslog is **not** installed on the server.","example":"8.24.0-16","oneOf":[{"description":"A version number of Rsyslog.","type":"string"},{"description":"Rsyslog is **not** installed.","enum":[0],"type":"integer"}]},"spamd":{"description":"The Apache SpamAssassin™ version number.\n\n* `0` - Apache SpamAssassin is **not** installed on the server.","example":"3.4.2","oneOf":[{"description":"A version number of Apache SpamAssassin.","type":"string"},{"description":"Apache SpamAssassin is **not** installed.","enum":[0],"type":"integer"}]}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"installed_versions","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return third-party software versions","tags":["Updates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n installed_versions\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/installed_versions?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"64"}},"/system_needs_reboot":{"get":{"description":"This function determines if your system requires a reboot to apply quotas, software package updates, or kernel updates.\n\n**Important:**\n\nThis function **cannot** detect whether your system needs a reboot if you use cPanel & WHM inside of a [Linux Container (LXC)](https://docs.cpanel.net/knowledge-base/general-systems-administration/linux-containers/).","operationId":"system_needs_reboot","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"details":{"description":"An object that contains reasons why the system requires a reboot.","properties":{"kernel":{"description":"An object of kernel versions.\n\n**Note:**\n\nThe function **only** returns this object if the kernel updates and requires a reboot.","properties":{"boot_version":{"description":"The version that the system's kernel updated to.","example":"3.10.0-514.10.2.e17.x86_64","type":"string"},"running_version":{"description":"The kernel version that the server currently runs.","example":"3.10.0-514.10.2.e17.x86_64","type":"string"}},"type":"object"},"quota":{"description":"Whether the system requires a reboot to enable quotas.\n\n* `1` — System requires a reboot to enable quotas.\n\n**Note:**\n\nThe function **only** returns this value if the kernel updates and requires a reboot.","enum":[1],"example":1,"type":"integer"},"updates":{"description":"A list of software packages that require an update and their most recent versions.\n\n**Note:**\n\nThe function **only** returns this object if software packages on your server require updates.","example":{"glibc":"2.17-157.el7_3.1"},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"system_needs_reboot","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}},"needs_reboot":{"description":"Whether the system requires a reboot.\n\n* `1` — System requires a reboot.\n* `0` — System does **not** require a reboot.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether system needs reboot","tags":["Server Administration","System Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n system_needs_reboot\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/system_needs_reboot?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"64"}},"/disable_failing_authentication_providers":{"get":{"description":"This function disables any enabled identity provider modules that fail to load.","operationId":"disable_failing_authentication_providers","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects containing information about the external authentication identity provider module failures.","items":{"properties":{"disabled_services":{"description":"An array of the cPanel services for which the external authentication identity provider was previously disabled.","example":["cpaneld","webmaild"],"items":{"type":"string"},"type":"array"},"failures_to_disable":{"description":"An array of objects containing the cPanel services for which the system fails to disable the module.","items":{"properties":{"failure":{"description":"A description of the failure to disable the identity provider module for that module.","example":"An informative failure message.","type":"string"},"service_name":{"description":"A cPanel service for which the system failed to disable the external authentication identity provider.","example":"whostmgrd","type":"string"}},"type":"object"},"type":"array"},"provider_failure":{"description":"A description of the failure.","example":"(ERR mcddbv) The system failed to load the module “Cpanel::Security::Authn::Provider::Facebook“ because of an error: Can't locate Cpanel/Security/Authn/Provider/Facebook.pm in @INC (@INC contains: /usr/local/cpanel /usr/local/cpanel/3rdparty/perl/514/lib/perl5/cpanel_lib/i386-linux-64int /usr/local/cpanel/3rdparty/perl/514/lib/perl5/cpanel_lib /usr/local/cpanel/3rdparty/perl/514/lib/perl5/5.14.4/i386-linux-64int /usr/local/cpanel/3rdparty/perl/514/lib/perl5/5.14.4 /opt/cpanel/perl5/514/site_lib/i386-linux-64int /opt/cpanel/perl5/514/site_lib /var/cpanel/perl) at (eval 143) line 1.\nBEGIN failed--compilation aborted at (eval 143) line 1.\n","type":"string"},"provider_name":{"description":"The external authentication identity provider to disable.","example":"facebook","type":"string"},"provider_namespace":{"description":"The external authentication identity provider module's namespace.","example":"Cpanel::Security::Authn::Provider::Facebook","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"disable_failing_authentication_providers","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable identity provider modules that fail to load","tags":["Authentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n disable_failing_authentication_providers\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/disable_failing_authentication_providers?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/get_available_authentication_providers":{"get":{"description":"This function lists available external authentication identity providers for all services.","operationId":"get_available_authentication_providers","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"providers":{"description":"An array of available identity provider names and settings. Each hash in the array includes the cpaneld_link , whostmgrd_link , webmaild_link , icon , icon_type , provider_name , display_name , documentation_url , color , configured , id , label , textcolor , whostmgr_enabled , cpaneld_enabled , and webmaild_enabled returns.","items":{"properties":{"color":{"description":"The background color of the button on the cPanel interface. A valid RGB hexadecimal color value.","example":"dd4b39","type":"string"},"configured":{"description":"Whether the identity provider is configured on the server.\n- 1 The provider is configured.\n- 0 The provider is not configured.","enum":[0,1],"example":1,"type":"integer"},"cpaneld_enabled":{"description":"Whether the identity provider is enabled for the cpaneld service.\n- 1 The provider is enabled for the cpaneld service..\n- 0 The provider is not enabled for the cpaneld service.","enum":[0,1],"example":1,"type":"integer"},"cpaneld_link":{"description":"link to the identity provider's configuration for the cpaneld service on the system. A valid URL .","example":"https://hostname.example.com:2083/openid_connect/cpanelid","type":"string"},"display_name":{"description":"The display name of the identity provider. A valid string.","example":"cPanel","type":"string"},"documentation_url":{"description":"The URL to the identity provider's documentation. A valid URL.","example":"https://go.cpanel.net/cpanelidmanage","type":"string"},"icon":{"description":"The icon file to display in the button on the cPanel login interface. A valid Base64-encoded, JPG or PNG-formatted image file.","example":"Click to view...iVBORw0KGgoAAAANSUhEUgAAACEAAAAhCAYAAABX5MJvAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAV1JREFUeNrsVtGNwjAMJegGYIRucBmhtwEjdAMyQjYoG2SEG6HcBGUDugFskHOQg1zTlFaN\\/\\/KkqMh2yYvt53S3KygomIZaE+y9P8BDJ9xXpdSDxT9jwX7dxDJsDMvCuvl33GF1sBwS5O8GX7eVgCabGyRkGJF25v0sJHrcyDH7iMhWEl9zWSD1\\/xs1klJn8J\\/gZ4WxNdgu8KyiDXGIfmJ7LO6R8CI5rJnwO+Kv0Wb9Z7xlZr+wMt8f\\/ANmyCoCMF3CUmP8rOmHip1AM\\/8tdbLcjfnL5NigYmIp+ilp5iYRJNkmajtLIBuJiUZ1S+aDKGDjI8tGk+N\\/9yuy0ODcGIjL8UEmcXKLDelRDQ5tHcuIkSLQE1WYhIRfMRIEmiV1Z7NES5Rh9nIisRGVWGOyyyflC5fSkDsTmk1KnVBMbForqQw+IVtUCP3KEpdojffHnRGKcq3LZ3pBgST+BRgANXt+WPKE7tYAAAAASUVORK5CYII=","type":"string"},"icon_type":{"description":"The icon file's MIME type. A valid image format's MIME type.","example":"image/svg+xml","type":"string"},"id":{"description":"The ID of the identity provider. A valid string.","example":"cpanelid","type":"string"},"label":{"description":"The text label that will appear on the cPanel login interface. A valid string.","example":"Log in with a cPanelID Account","type":"string"},"provider_name":{"description":"The name of the identity provider. A valid string.","example":"cpanel","type":"string"},"textcolor":{"description":"The color of the text label on the cPanel login interface. A valid RGB hexadecimal color value.","example":"FFFFFF","type":"string"},"webmaild_enabled":{"description":"Whether the identity provider is enabled for the webmaild service.\n- 1 The provider is enabled for the webmaild service.\n- 0 The provider is not enabled for the webmaild service.","enum":[0,1],"example":1,"type":"integer"},"webmaild_link":{"description":"link to the identity provider's configuration for the webmaild service on the system. A valid URL .","example":"https://hostname.example.com:2096/openid_connect/cpanelid","type":"string"},"whostmgr_enabled":{"description":"Whether the identity provider is enabled for the whostmgr service.\n- 1 The provider is enabled for the whostmgr service.\n- 0 The provider is not enabled for the whostmgr service.","enum":[0,1],"example":1,"type":"integer"},"whostmgrd_link":{"description":"link to the identity provider's configuration for the whostmgrd service on the system. A valid URL.","example":"https://hostname.example.com:2087/openid_connect/cpanelid","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_available_authentication_providers","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return available identity providers","tags":["Authentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_available_authentication_providers\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_available_authentication_providers?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/enable_authentication_provider":{"get":{"description":"This function enables an external authentication identity provider for a specified service.","operationId":"enable_authentication_provider","parameters":[{"description":"The cPanel & WHM service's name:\n\n* `cpaneld`\n* `webmaild`\n* `whostmgrd`","in":"query","name":"service_name","required":true,"schema":{"enum":["cpaneld","webmaild","whostmgrd"],"example":"cpaneld","type":"string"}},{"description":"A valid identity provider's identification key.","in":"query","name":"provider_id","required":true,"schema":{"example":"cpanelid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"enable_authentication_provider","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable identity provider","tags":["Authentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n enable_authentication_provider \\\n service_name='cpaneld' \\\n provider_id='cpanelid'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/enable_authentication_provider?api.version=1&service_name=cpaneld&provider_id=cpanelid"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/get_provider_client_configurations":{"get":{"description":"This function retrieves the configuration details for the client of an external authentication identity provider.","operationId":"get_provider_client_configurations","parameters":[{"description":"The cPanel & WHM service's name.\n* `cpaneld` — The cPanel daemon.\n* `whostmgrd` — The WHM daemon.\n* `webmaild` — The Webmail daemon.","in":"query","name":"service_name","required":true,"schema":{"enum":["cpaneld","whostmgrd","webmaild"],"example":"cpaneld","type":"string"}},{"description":"The identity provider's key.","in":"query","name":"provider_id","required":true,"schema":{"example":"cpanelid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"client_configurations":{"description":"An object that contains the client configuration information.","properties":{"client_id":{"description":"The client ID for the identity provider.","example":"1234567890","type":"string"},"client_secret":{"description":"The secret for the client ID.","example":"victoria","type":"string"},"redirect_uris":{"description":"The redirection URIs for each interface that the identity provider uses.","example":["https://hostname.example.com:2083/openid_connect_callback/cpanelid","https://hostname.example.com:2087/openid_connect_callback/cpanelid","https://hostname.example.com:2096/openid_connect_callback/cpanelid"],"items":{"format":"url","type":"string"},"type":"array"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_provider_client_configurations","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return identity provider client configuration","tags":["Authentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_provider_client_configurations \\\n service_name='cpaneld' \\\n provider_id='cpanelid'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_provider_client_configurations?api.version=1&service_name=cpaneld&provider_id=cpanelid"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/get_provider_configuration_fields":{"get":{"description":"This function retrieves the configuration fields for a external authentication identity provider.","operationId":"get_provider_configuration_fields","parameters":[{"description":"The cPanel & WHM service's name.\n\n* `cpaneld`\n* `whostmgrd`\n* `webmaild`","in":"query","name":"service_name","required":true,"schema":{"enum":["cpaneld","whostmgrd","webmaild"],"example":"cpaneld","type":"string"}},{"description":"The identity provider's key.","in":"query","name":"provider_id","required":true,"schema":{"example":"cpanelid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"configuration_fields":{"description":"An array of objects containing the configuration information for each field.","example":[{"description":"The Secret of the Client","display_order":1,"field_id":"client_secret","label":"Client Secret","value":null},{"description":"The ID of the Client.","display_order":0,"field_id":"client_id","label":"Client ID","value":null}],"items":{"properties":{"description":{"description":"The description of the configuration field.","type":"string"},"display_order":{"description":"The display order of the configuration field.","minimum":0,"type":"integer"},"field_id":{"description":"The name of the configuration field.","type":"string"},"label":{"description":"The label of the configuration field.","type":"string"},"value":{"description":"The value of the configuration field, if available.","nullable":true,"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_provider_configuration_fields","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return identity provider configuration fields","tags":["Authentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_provider_configuration_fields \\\n service_name='cpaneld' \\\n provider_id='cpanelid'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_provider_configuration_fields?api.version=1&service_name=cpaneld&provider_id=cpanelid"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/get_provider_display_configurations":{"get":{"description":"This function retrieves the display configuration for the login button of an external authentication identity provider.","operationId":"get_provider_display_configurations","parameters":[{"description":"The identity provider's key.","in":"query","name":"provider_id","required":true,"schema":{"example":"google","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"configurations":{"description":"An array of objects containing information about each service's external authentication display information.","example":[{"color":"dd4b39","display_name":"Google","documentation_url":"https://developers.google.com/identity/protocols/OpenIDConnect","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4=","icon_type":"image/svg+xml","label":"Log in via Google","link":"/openid_connect/google","provider_name":"google","service":"cpaneld","textcolor":"FFFFFF"},{"color":"dd4b39","display_name":"Google","documentation_url":"https://developers.google.com/identity/protocols/OpenIDConnect","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4=","icon_type":"image/svg+xml","label":"Log in via Google","link":"/openid_connect/google","provider_name":"google","service":"webmaild","textcolor":"FFFFFF"},{"color":"dd4b39","display_name":"Google","documentation_url":"https://developers.google.com/identity/protocols/OpenIDConnect","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4=","icon_type":"image/svg+xml","label":"Log in via Google","link":"/openid_connect/google","provider_name":"google","service":"whostmgrd","textcolor":"FFFFFF"}],"items":{"properties":{"color":{"description":"The background color of the button in the cPanel interface.","format":"RGB","type":"string"},"display_name":{"description":"The display name of the identity provider.","type":"string"},"documentation_url":{"description":"The URL to the identity provider's documentation.","format":"url","type":"string"},"icon":{"description":"The icon file in the button that the cPanel login interface displays.","format":"byte","type":"string"},"icon_type":{"description":"The icon file's MIME type.","type":"string"},"label":{"description":"The text label in the button that the cPanel login interface displays.","type":"string"},"link":{"description":"A reference URL to the identity provider's configuration for the system.","type":"string"},"provider_name":{"description":"The name of the identity provider.","type":"string"},"service":{"description":"The service's name.\n\n* `cpaneld`\n* `whostmgrd`\n* `webmaild`","enum":["cpaneld","whostmgrd","webmaild"],"type":"string"},"textcolor":{"description":"The color of the text label in the button that the cPanel login interface displays.","format":"RGB","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_provider_display_configurations","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return identity provider login interface appearance","tags":["Authentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_provider_display_configurations \\\n provider_id='google'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_provider_display_configurations?api.version=1&provider_id=google"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58.0.12"}},"/set_provider_client_configurations":{"get":{"description":"This function sets the values of configuration fields for an external authentication identity provider.","operationId":"set_provider_client_configurations","parameters":[{"description":"The cPanel & WHM service's name.\n* `cpaneld` — The cPanel daemon.\n* `whostmgrd` — The WHM daemon.\n* `webmaild` — The Webmail daemon.","in":"query","name":"service_name","required":true,"schema":{"enum":["cpaneld","whostmgrd","webmaild"],"example":"cpaneld","type":"string"}},{"description":"The identity provider's key.","in":"query","name":"provider_id","required":true,"schema":{"example":"cpanelid","type":"string"}},{"description":"The configuration values to set for the identity provider.\n\n**Note**\n \nThe items in this parameter depend on the fields that the provider implements through OpenID.","in":"query","name":"configurations","required":true,"schema":{"example":"{\"client_id\":\"victoria\",\"client_secret\":\"secret\"}","format":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_provider_client_configurations","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update identity provider client configuration","tags":["Authentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_provider_client_configurations \\\n service_name='cpaneld' \\\n provider_id='cpanelid' \\\n configurations='{\"client_id\":\"victoria\",\"client_secret\":\"secret\"}'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_provider_client_configurations?api.version=1&service_name=cpaneld&provider_id=cpanelid&configurations=%7b%22client_id%22%3a%22victoria%22%2c%22client_secret%22%3a%22secret%22%7d"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/backup_config_set":{"get":{"description":"This function configures a server's backup system. The system saves these settings in the `/var/cpanel/backups/config` file.","operationId":"backup_config_set","parameters":[{"description":"Whether to enable daily backups.\n\n* `1` — Enable.\n* `0` — Disable.","in":"query","name":"backup_daily_enable","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The number of daily backups to retain.","in":"query","name":"backup_daily_retention","required":false,"schema":{"default":5,"example":5,"minimum":0,"type":"integer"}},{"description":"Which days of the month to run backups.\n\n**Note:**\n\nTo add multiple days, use a comma-delimited list.","in":"query","name":"backup_monthly_dates","required":false,"schema":{"default":1,"example":1,"maximum":31,"minimum":1,"type":"integer"}},{"description":"Whether to enable monthly backups.\n\n* `1` — Enable.\n* `0` — Disable.","in":"query","name":"backup_monthly_enable","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"The number of monthly backups to retain.","in":"query","name":"backup_monthly_retention","required":false,"schema":{"default":1,"example":5,"minimum":0,"type":"integer"}},{"description":"Which day of the week to run weekly backups.\n\n* `0` — Sunday.\n* `1` — Monday.\n* `2` — Tuesday.\n* `3` — Wednesday.\n* `4` — Thursday.\n* `5` — Friday.\n* `6` — Saturday.","in":"query","name":"backup_weekly_day","required":false,"schema":{"default":0,"example":1,"maximum":6,"minimum":1,"type":"integer"}},{"description":"Whether to enable weekly backups.\n\n* `1` — Enable.\n* `0` — Disable.","in":"query","name":"backup_weekly_enable","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"The number of weekly backups to retain.","in":"query","name":"backup_weekly_retention","required":false,"schema":{"default":4,"example":4,"minimum":0,"type":"integer"}},{"description":"Whether to back up cPanel user accounts.\n\n* `1` — Back up.\n* `0` — Do **not** back up.\n\n**Note:**\n\nThis setting affects whether the system enables the *File and Directory Restoration*\ninterfaces in\n[cPanel](https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/)\nand in\n[WHM](https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/).\nFor more information, read the\n[How to Manage Metadata Settings](https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/)\ndocumentation.","in":"query","name":"backupaccts","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to back up bandwidth tracking data.\n\n* `1` — Back up.\n* `0` — Do **not** back up.","in":"query","name":"backupbwdata","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Which days of the week to run daily backups.\n\n* `0` — Sunday.\n* `1` — Monday.\n* `2` — Tuesday.\n* `3` — Wednesday.\n* `4` — Thursday.\n* `5` — Friday.\n* `6` — Saturday.\n\n**Note:**\n\nFor multiple days, use a comma-delimited list.","in":"query","name":"backupdays","required":false,"schema":{"default":"0,2,4,6","example":"0,1,2,3,4,5,6","maximum":6,"minimum":0,"type":"string"}},{"description":"The primary backup directory.","in":"query","name":"backupdir","required":false,"schema":{"default":"/backup","example":"/backup","type":"string"}},{"description":"Whether to enable backups.\n\n* `1` — Enable.\n* `0` — Disable.\n\n**Note:**\n\nThis setting affects whether the system enables the *File and Directory Restoration*\ninterfaces in\n[cPanel](https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/)\nand in\n[WHM](https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/).\nFor more information, read the\n[How to Manage Metadata Settings](https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/)\ndocumentation.","in":"query","name":"backupenable","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to back up system files.\n\n* `1` — Back up.\n* `0` — Do **not** back up.","in":"query","name":"backupfiles","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to back up the error logs.\n\n* `1` — Back up.\n* `0` — Do **not** back up.","in":"query","name":"backuplogs","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to mount a backup partition.\n\n* `1` — Mount.\n* `0` — Do **not** mount.\n\n**Note:**\n\nThis setting affects whether the system enables the *File and Directory Restoration*\ninterfaces in\n[cPanel](https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/)\nand in\n[WHM](https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/).\nFor more information, read the\n[How to Manage Metadata Settings](https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/)\ndocumentation.","in":"query","name":"backupmount","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to back up suspended accounts.\n\n* `1` — Back up.\n* `0` — Do **not** back up.","in":"query","name":"backupsuspendedaccts","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"The type of backup to create.\n\n* `compressed`\n* `uncompressed`\n* `incremental`","in":"query","name":"backuptype","required":false,"schema":{"default":"compressed","enum":["compressed","uncompressed","incremental"],"example":"compressed","type":"string"}},{"description":"Whether to ensure that the destination server possesses the minimum\nfree disk space available.\n\n* `1` — Check the free disk space on the destination server.\n* `0` — Do **not** check the free disk space on the destination server.","in":"query","name":"check_min_free_space","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether the backup system will create metadata when a backup runs.\n\n* `1` — Disable metadata creation.\n* `0` — Enable metadata creation.\n\n**Note:**\n\nThis setting affects whether the system enables the *File and Directory Restoration*\ninterfaces in\n[cPanel](https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/)\nand in\n[WHM](https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/).\nFor more information, read the\n[How to Manage Metadata Settings](https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/)\ndocumentation.","in":"query","name":"disable_metadata","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"The number of times that the system will try to use the additional backup destination.","in":"query","name":"errorthreshhold","required":false,"schema":{"default":3,"example":3,"minimum":0,"type":"integer"}},{"description":"Whether to strictly enforce the value of the `backup_daily_retention`\nparameter.\n\n* `1` — Strictly enforce the `backup_daily_retention` parameter.\n* `0` — Only enforce the `backup_daily_retention` parameter **after** a\nsuccessful complete backup.","in":"query","name":"force_prune_daily","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to strictly enforce the value of the `backup_monthly_retention`\nparameter.\n\n* `1` — Strictly enforce the `backup_monthly_retention` parameter.\n* `0` — Only enforce the `backup_monthly_retention` parameter **after** a\nsuccessful complete backup.","in":"query","name":"force_prune_monthly","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to strictly enforce the value of the `backup_weekly_retention`\nparameter.\n\n* `1` — Strictly enforce the `backup_weekly_retention` parameter.\n* `0` — Only enforce the `backup_weekly_retention` parameter **after** a\nsuccessful complete backup.","in":"query","name":"force_prune_weekly","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"The `gzip` environment variables.","in":"query","name":"gziprsyncopts","required":false,"schema":{"default":"","example":"--rysncable","type":"string"}},{"description":"Whether to delete backups from the local directory.\n\n* `1` — Delete.\n* `0` — Do **not** delete.\n\n**Note:**\n\nThis setting affects whether the system enables the *File and Directory Restoration*\ninterfaces in\n[cPanel](https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/)\nand in\n[WHM](https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/).\nFor more information, read the\n[How to Manage Metadata Settings](https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/)\ndocumentation.","in":"query","name":"keeplocal","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to check the `rsync` function for hardlink support.\n\n* `1` — Check.\n* `0` — Do **not** check.","in":"query","name":"linkdest","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to use a local zone file from the `/var/named/domain.tld`\nfile or the `dnsadmin` daemon, where `domain.tld` represents the target domain.\n\n* `1` — Use the `/var/named/domain.tld` file.\n* `0` — Use `dnsadmin`.","in":"query","name":"localzonesonly","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"How long a restoration will attempt to run, in seconds. If the restoration does not succeed in this amount of time, it will stop.","in":"query","name":"maximum_restore_timeout","required":false,"schema":{"default":21600,"example":21600,"minimum":0,"type":"integer"}},{"description":"How long a backup will attempt to run, in seconds. If the backup does not succeed in this amount of time, it will stop.","in":"query","name":"maximum_timeout","required":false,"schema":{"default":7200,"example":7200,"minimum":0,"type":"integer"}},{"description":"The minimum amount of free disk to check for on the destination server.\n\n**Note:**\n\nIf the value of the `min_free_space_unit` parameter is `percent`, the maximum\nvalue is `100`.","in":"query","name":"min_free_space","required":false,"schema":{"default":5,"example":1024,"minimum":0,"type":"integer"}},{"description":"The units of measurement of disk space for the `min_free_space` return.\n\n* `MB` — Megabytes.\n* `percent` — Percent available.","in":"query","name":"min_free_space_unit","required":false,"schema":{"default":"percent","enum":["MB","percent"],"example":"MB","type":"string"}},{"description":"The backup method to use for MySQL® databases.\n\n* `accounts` — Back up databases in each account's archive.\n* `dir` — Back up the entire MySQL directory.\n* `both` — Back up databases in each account's archive and the entire\nMySQL directory.","in":"query","name":"mysqlbackup","required":false,"schema":{"default":"accounts","enum":["accounts","dir","both"],"example":"accounts","type":"string"}},{"description":"Whether to run the `/usr/local/cpanel/scripts/postcpbackup` script after\nthe backup finishes.\n\n* `1` — Run.\n* `0` — Do **not** run.","in":"query","name":"postbackup","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to run the `/usr/local/cpanel/scripts/precpbackup` script before\nthe system processes backups.\n\n* `1` — Run.\n* `0` — Do **not** run.","in":"query","name":"prebackup","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to back up PostgreSQL® databases.\n\n* `1` — Back up.\n* `0` — Do **not** back up.","in":"query","name":"psqlbackup","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"The directory that temporarily stores a remote backup's data during a backup restoration.\nThe data is a compressed (`.tar.gz`) or uncompressed (`.tar`) account tarball.\n\n**Important:**\n\nThe system restores backups one at a time. The backup staging directory **must**\nbe large enough to contain the largest remote backup file that you wish to restore.\nFor example, if you wish to restore three backups, sized 1.5 GB, 528 MB, and\n950 MB each, your backup staging directory must be able to hold at **least** 1.5 GB.\n\n**Note:**\n\nThe system empties the directory after the system restores the backup.","in":"query","name":"remote_restore_staging_dir","required":false,"schema":{"example":"/backup","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_config_set","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update the system's backup configuration","tags":["Backups","Backup Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_config_set\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_config_set?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/set_provider_display_configurations":{"get":{"description":"This function sets the display configuration for the login button of an external authentication identity provider.","operationId":"set_provider_display_configurations","parameters":[{"description":"The cPanel & WHM service's name.\n* `cpaneld` — The cPanel daemon.\n* `whostmgrd` — The WHM daemon.\n* `webmaild` — The Webmail daemon.","in":"query","name":"service_name","required":true,"schema":{"enum":["cpaneld","whostmgrd","webmaild"],"example":"cpaneld","type":"string"}},{"description":"The identity provider's key.","in":"query","name":"provider_id","required":true,"schema":{"example":"cpanelid","type":"string"}},{"content":{"application/json":{"example":{"color":"6677aa","display_name":"Hosting Center Login","textcolor":"44ffbb"},"schema":{"properties":{"color":{"description":"The background color of the button on the cPanel interface.","example":"dd4b39","format":"RGB","type":"string"},"display_name":{"description":"The display name of the identity provider.","example":"cPanel","type":"string"},"icon":{"description":"The icon file to display in the button on the cPanel login interface.","example":"iVBORw0KGgoAAAANSUhEUgAAACEAAAAhCAYAAABX5MJvAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAV1JREFUeNrsVtGNwjAMJegGYIRucBmhtwEjdAMyQjYoG2SEG6HcBGUDugFskHOQg1zTlFaN\\/\\/KkqMh2yYvt53S3KygomIZaE+y9P8BDJ9xXpdSDxT9jwX7dxDJsDMvCuvl33GF1sBwS5O8GX7eVgCabGyRkGJF25v0sJHrcyDH7iMhWEl9zWSD1\\/xs1klJn8J\\/gZ4WxNdgu8KyiDXGIfmJ7LO6R8CI5rJnwO+Kv0Wb9Z7xlZr+wMt8f\\/ANmyCoCMF3CUmP8rOmHip1AM\\/8tdbLcjfnL5NigYmIp+ilp5iYRJNkmajtLIBuJiUZ1S+aDKGDjI8tGk+N\\/9yuy0ODcGIjL8UEmcXKLDelRDQ5tHcuIkSLQE1WYhIRfMRIEmiV1Z7NES5Rh9nIisRGVWGOyyyflC5fSkDsTmk1KnVBMbForqQw+IVtUCP3KEpdojffHnRGKcq3LZ3pBgST+BRgANXt+WPKE7tYAAAAASUVORK5CYII=","type":"string"},"icon_type":{"default":"image/svg+xml","description":"The icon file's MIME type.","example":"image/svg+xml","format":"mime","type":"string"},"label":{"description":"The text label that will appear on the cPanel login interface.","example":"Log in with a cPanelID Account","type":"string"},"textcolor":{"description":"The color of the text label on the cPanel login interface.","example":"FFFFFF","format":"RGB","type":"string"}},"type":"object"}}},"description":"The display configuration in JSON-encoded key-value format.","in":"query","name":"configurations","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_provider_display_configurations","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update identity provider login interface appearance","tags":["Authentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty set_provider_display_configurations service_name='cpaneld' provider_id='cpanelid' configurations='{\"color\":\"dd4b39\",\"display_name\":\"cPanel\",\"icon\":\"iVBORw0KGgoAAAANSUhEUgAAACEAAAAhCAYAAABX5MJvAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAV1JREFUeNrsVtGNwjAMJegGYIRucBmhtwEjdAMyQjYoG2SEG6HcBGUDugFskHOQg1zTlFaN\\\\/\\\\/KkqMh2yYvt53S3KygomIZaE+y9P8BDJ9xXpdSDxT9jwX7dxDJsDMvCuvl33GF1sBwS5O8GX7eVgCabGyRkGJF25v0sJHrcyDH7iMhWEl9zWSD1\\\\/xs1klJn8J\\\\/gZ4WxNdgu8KyiDXGIfmJ7LO6R8CI5rJnwO+Kv0Wb9Z7xlZr+wMt8f\\\\/ANmyCoCMF3CUmP8rOmHip1AM\\\\/8tdbLcjfnL5NigYmIp+ilp5iYRJNkmajtLIBuJiUZ1S+aDKGDjI8tGk+N\\\\/9yuy0ODcGIjL8UEmcXKLDelRDQ5tHcuIkSLQE1WYhIRfMRIEmiV1Z7NES5Rh9nIisRGVWGOyyyflC5fSkDsTmk1KnVBMbForqQw+IVtUCP3KEpdojffHnRGKcq3LZ3pBgST+BRgANXt+WPKE7tYAAAAASUVORK5CYII=\",\"icon_type\":\"image/svg+xml\",\"label\":\"Log in with a cPanelID Account\",\"textcolor\":\"FFFFFF\"}'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_provider_display_configurations?api.version=1&service_name=cpaneld&provider_id=cpanelid&configurations=%7b%22color%22%3a%22dd4b39%22%2c%22display_name%22%3a%22cPanel%22%2c%22icon%22%3a%22iVBORw0KGgoAAAANSUhEUgAAACEAAAAhCAYAAABX5MJvAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAV1JREFUeNrsVtGNwjAMJegGYIRucBmhtwEjdAMyQjYoG2SEG6HcBGUDugFskHOQg1zTlFaN%5c%5c%2f%5c%5c%2fKkqMh2yYvt53S3KygomIZaE%2by9P8BDJ9xXpdSDxT9jwX7dxDJsDMvCuvl33GF1sBwS5O8GX7eVgCabGyRkGJF25v0sJHrcyDH7iMhWEl9zWSD1%5c%5c%2fxs1klJn8J%5c%5c%2fgZ4WxNdgu8KyiDXGIfmJ7LO6R8CI5rJnwO%2bKv0Wb9Z7xlZr%2bwMt8f%5c%5c%2fANmyCoCMF3CUmP8rOmHip1AM%5c%5c%2f8tdbLcjfnL5NigYmIp%2bilp5iYRJNkmajtLIBuJiUZ1S%2baDKGDjI8tGk%2bN%5c%5c%2f9yuy0ODcGIjL8UEmcXKLDelRDQ5tHcuIkSLQE1WYhIRfMRIEmiV1Z7NES5Rh9nIisRGVWGOyyyflC5fSkDsTmk1KnVBMbForqQw%2bIVtUCP3KEpdojffHnRGKcq3LZ3pBgST%2bBRgANXt%2bWPKE7tYAAAAASUVORK5CYII%3d%22%2c%22icon_type%22%3a%22image%2fsvg%2bxml%22%2c%22label%22%3a%22Log%20in%20with%20a%20cPanelID%20Account%22%2c%22textcolor%22%3a%22FFFFFF%22%7d"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/backup_date_list":{"get":{"description":"This function lists the dates where backup file exists, whether stored locally or stored on remote backup destinations when local backups are disabled.","operationId":"backup_date_list","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"backup_set":{"description":"A list of dates containing the backup files.","example":["2019-02-12T00:00:00.000Z","2019-02-12T00:00:00.000Z","2019-02-12T00:00:00.000Z"],"items":{"format":"ISO-8601 Date","type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_date_list","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return dates where backup files exist","tags":["Backups","Backup Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_date_list\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_date_list?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/backup_destination_add":{"get":{"description":"This function adds a backup destination.","operationId":"backup_destination_add","parameters":[{"description":"The backup destination's name.","in":"query","name":"name","required":true,"schema":{"example":"destination_name","type":"string"}},{"description":"The type of backup destination.\n\n* `Custom`\n* `FTP`\n* `Local`\n* `SFTP`\n* `WebDAV`\n* `AmazonS3`\n* `Rsync`\n* `GoogleDrive`\n* `S3Compatible`\n* `Backblaze`\n\n**Note:**\n\nThis value determines which parameters you can use with the function.\n\n**Warning:**\n\nUse any of these encrypted connections to transfer system backup files:\n\n* Amazon S3™\n* Backblaze\n* GoogleDrive\n* Rsync\n* S3 Compatible\n* SFTP\n* WebDAV with SSL enabled","in":"query","name":"type","required":true,"schema":{"enum":["Custom","FTP","Local","SFTP","WebDAV","AmazonS3","Rsync","GoogleDrive","S3Compatible","Backblaze"],"example":"Local","type":"string"}},{"description":"Whether to disable the backup destination.\n\n* `1` — Disable the backup destination.\n* `0` — Enable the backup destination.","in":"query","name":"disabled","required":true,"schema":{"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to upload system backups.\n\n* `1` — Upload system backups.\n* `0` — Do **not** upload system backups.","in":"query","name":"upload_system_backup","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to use this transport only for logs.\n\n* `1` — This destination will be skipped for regular backups.\n* `0` — Both log and regular backups will be uploaded.\n\nThis setting defaults to 0.\nThe only time log files get their own backup is via scripts/remote_log_transfer","in":"query","name":"only_used_for_logs","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The session timeout, measured in seconds.\n\n**Note:**\n\n* This parameter is **not** valid for the `Local` backup `type` parameter.\n* The default value depends on the `type` parameter's value.","in":"query","name":"timeout","required":false,"schema":{"example":30,"type":"integer"}},{"description":"The path to the backups directory on the remote server.\n\n**Note:**\n\nThis parameter is only valid for the following backup types:\n* `AmazonS3`\n* `GoogleDrive`\n* `S3Compatible`","in":"query","name":"folder","required":false,"schema":{"default":"","example":"subfolder","type":"string"}},{"description":"The Amazon S3™ bucket.\n\n**Note:**\n\nThis parameter is only valid for the following backup types:\n* `AmazonS3`\n* `S3Compatible`","in":"query","name":"bucket","required":true,"schema":{"example":"ChockFullOfNuts","type":"string"}},{"description":"The Amazon S3™ Access Key ID.\n\n**Note:**\n\nThis parameter is only valid for the following backup types:\n* `AmazonS3`\n* `S3Compatible`","in":"query","name":"aws_access_key_id","required":true,"schema":{"example":"AKIAYLWMPOZZJCERC28Q","type":"string"}},{"description":"The remote server account's password or secret\naccess key.\n\n**Note:**\n\nThis parameter is only valid for the following backup types:\n* `AmazonS3`\n* `Custom`\n* `FTP`\n* `SFTP`\n* `Rsync`\n* `WebDAV`\n* `S3Compatible`","in":"query","name":"password","required":true,"schema":{"example":"123456luggage","type":"string"}},{"description":"The path to the backups directory on the remote server.\n\n* This parameter is **required** for the `Local` backup type.\n* If you do **not** use this parameter, the system will not set a value.\n\n**Note:**\n\nThis parameter is only valid for the following backup types:\n* `Backblaze`\n* `Custom`\n* `Local`\n* `FTP`\n* `SFTP`\n* `Rsync`\n* `WebDAV`","in":"query","name":"path","required":false,"schema":{"default":null,"example":"backups","type":"string"}},{"description":"The application key's name.\n\n**Note:**\n\nThis parameter is only valid for the `Backblaze` backup type.","in":"query","name":"application_key","required":true,"schema":{"example":"A123b45CD678e9","type":"string"}},{"description":"The application key ID that authenticates the Backblaze B2 account.\n\n**Note:**\n\nThis parameter is only valid for the `Backblaze` backup type.","in":"query","name":"application_key_id","required":true,"schema":{"example":"12a345B678c9","type":"string"}},{"description":"The bucket's ID string.\n\n**Note:**\n\nThis parameter is only valid for the `Backblaze` backup type.","in":"query","name":"bucket_id","required":true,"schema":{"example":"a12b34cd5678e9f","type":"string"}},{"description":"The bucket's name.\n\n**Note:**\n\nThis parameter is only valid for the `Backblaze` backup type.","in":"query","name":"bucket_name","required":true,"schema":{"example":"ChockFullOfNuts","type":"string"}},{"description":"The absolute file path to the user-supplied transport solution script.\n\n**Note:**\n\nThis parameter is only valid for the `Custom` backup type.","in":"query","name":"script","required":true,"schema":{"example":"/home/backups/beammeupscotty.pl","type":"string"}},{"description":"The remote server's hostname.\n\n**Note:**\n\nThis parameter is only valid for the following backup types:\n* `Custom`\n* `FTP`\n* `SFTP`\n* `Rsync`\n* `WebDAV`\n* `S3Compatible`","in":"query","name":"host","required":true,"schema":{"example":"backups.example.com","format":"hostname","type":"string"}},{"description":"The remote server account's username.\n\n**Note:**\n\nThis parameter is only valid for the following backup types:\n* `Custom`\n* `FTP`\n* `SFTP`\n* `Rsync`\n* `WebDAV`","in":"query","name":"username","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The TCP port to use.\n\n**Note:**\n\n* This parameter defaults to the standard port used by the queried backup `type` parameter.\n* This parameter is only valid for the following backup types:\n * `FTP`\n * `SFTP`\n * `Rsync`\n * `WebDAV`","in":"query","name":"port","required":false,"schema":{"example":21,"maximum":65535,"minimum":1,"type":"integer"}},{"description":"Whether to use passive FTP.\n\n* `1` — Use passive FTP.\n* `0` — Use active FTP.\n\n**Note:**\n\nThis parameter is only valid for the `FTP` backup type.","in":"query","name":"passive","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The Google Drive client ID.\n\n**Note:**\n\nThis parameter is only valid for the `GoogleDrive` backup type.","in":"query","name":"client_id","required":true,"schema":{"example":"aBcdeFgHIjK123","type":"string"}},{"description":"The Google Drive client secret.\n\n**Note:**\n\nThis parameter is only valid for the `GoogleDrive` backup type.","in":"query","name":"client_secret","required":true,"schema":{"example":"aBcde123FgHIjK456","type":"string"}},{"description":"Whether the path is mounted.\n\n* `1` — The path is mounted.\n* `0` — The path is **not** mounted.\n\n**Note:**\n\nThis parameter is only valid for the `Local` backup type.","in":"query","name":"mount","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to fail the backup attempt if the mount fails.\n\n* `1` — Fail the backup attempt.\n* `0` — Do **not** fail the backup attempt.\n\n**Note:**\n\nThis parameter is only valid for the `Local` backup type.","in":"query","name":"no_mount_fail","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The authorization type.\n\n* `password`\n* `key`\n\n**Note:**\n\nThis parameter is only valid for the following backup types:\n* `SFTP`\n* `Rsync`","in":"query","name":"authtype","required":true,"schema":{"enum":["password","key"],"example":"password","type":"string"}},{"description":"The file path to the private key file, if the `authtype` parameter is the `key` value.\n\n**Note:**\n\nThis parameter is only valid for the following backup types:\n* `SFTP`\n* `Rsync`","in":"query","name":"privatekey","required":false,"schema":{"default":null,"example":"/home/backups/key","type":"string"}},{"description":"The private key file's passphrase, if the `authtype` parameter is the `key` value.\n\n**Note:**\n\nThis parameter is only valid for the following backup types:\n* `SFTP`\n* `Rsync`","in":"query","name":"passphrase","required":false,"schema":{"default":null,"example":"123456luggage","type":"string"}},{"description":"Whether to use SSL.\n\n* `1` — Use SSL.\n* `0` — Do **not** use SSL.\n\n**Note:**\n\nThis parameter is only valid for the `WebDAV` backup type.","in":"query","name":"ssl","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"id":{"description":"The backup destination's ID.","example":"PhAxIoLSdIkCI40q9vWS4BYy","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_destination_add","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add a backup destination","tags":["Backups","Backup Destination"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_destination_add \\\n name='destination_name' \\\n type='Local' \\\n disabled='0' \\\n bucket='ChockFullOfNuts' \\\n aws_access_key_id='AKIAYLWMPOZZJCERC28Q' \\\n password='123456luggage' \\\n application_key='A123b45CD678e9' \\\n application_key_id='12a345B678c9' \\\n bucket_id='a12b34cd5678e9f' \\\n bucket_name='ChockFullOfNuts' \\\n script='/home/backups/beammeupscotty.pl' \\\n host='backups.example.com' \\\n username='username' \\\n client_id='aBcdeFgHIjK123' \\\n client_secret='aBcde123FgHIjK456' \\\n authtype='password'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_add?api.version=1&name=destination_name&type=Local&disabled=0&bucket=ChockFullOfNuts&aws_access_key_id=AKIAYLWMPOZZJCERC28Q&password=123456luggage&application_key=A123b45CD678e9&application_key_id=12a345B678c9&bucket_id=a12b34cd5678e9f&bucket_name=ChockFullOfNuts&script=%2fhome%2fbackups%2fbeammeupscotty.pl&host=backups.example.com&username=username&client_id=aBcdeFgHIjK123&client_secret=aBcde123FgHIjK456&authtype=password"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/backup_destination_delete":{"get":{"description":"This function removes a backup destination from the backup configuration file.","operationId":"backup_destination_delete","parameters":[{"description":"The destination's ID.","in":"query","name":"id","required":true,"schema":{"example":"11111111","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_destination_delete","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete a backup destination","tags":["Backups","Backup Destination"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_destination_delete \\\n id='11111111'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_delete?api.version=1&id=11111111"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/disable_authentication_provider":{"get":{"description":"This function disables a external authentication identity provider for a specified service.","operationId":"disable_authentication_provider","parameters":[{"description":"The cPanel & WHM service's name:\n\n* `cpaneld`\n* `webmaild`\n* `whostmgrd`","in":"query","name":"service_name","required":true,"schema":{"enum":["cpaneld","webmaild","whostmgrd"],"example":"cpaneld","type":"string"}},{"description":"A valid identity provider's identification key.","in":"query","name":"provider_id","required":true,"schema":{"example":"cpanelid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"disable_authentication_provider","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable identity provider","tags":["Authentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n disable_authentication_provider \\\n service_name='cpaneld' \\\n provider_id='cpanelid'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/disable_authentication_provider?api.version=1&service_name=cpaneld&provider_id=cpanelid"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/backup_destination_get":{"get":{"description":"Use this function to obtain a backup destination's settings.","operationId":"backup_destination_get","parameters":[{"description":"The backup destination's ID.","in":"query","name":"id","required":true,"schema":{"example":"0W1ei2rd3A4lI5sT6he7Be8st","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"amazons3":{"summary":"type=AmazonS3","value":{"data":{"aws_access_key_id":"access-key-id","bucket":"s3-bucket-brigade","disabled":0,"folder":"","id":"Sr1ThYOnnBIXUupTcSBYQywk","name":"Amazon S3","timeout":30,"type":"AmazonS3","upload_system_backup":0},"metadata":{"command":"backup_destination_get","reason":"OK","result":1,"version":1}}},"backblaze":{"summary":"type=BackBlaze","value":{"data":{"application_key":"keyS3cret","application_key_id":"appID","bucket_id":"backblaze-bucket-id","bucket_name":"backblaze-bucket-name","disabled":0,"id":"c85HdhrAkpiqumuXylEzrOcb","name":"BackBlaze","path":"","timeout":180,"type":"Backblaze","upload_system_backup":0},"metadata":{"command":"backup_destination_get","reason":"OK","result":1,"version":1}}},"custom":{"summary":"type=Custom","value":{"data":{"disabled":0,"host":"example.com","id":"Hhd85FsIxbxsLneBMNw1Dmdp","name":"destination unknown","path":"","script":"/bin/bacula_start","timeout":30,"type":"Custom","upload_system_backup":0,"username":"scott_bacula"},"metadata":{"command":"backup_destination_get","reason":"OK","result":1,"version":1}}},"ftp":{"summary":"type=FTP","value":{"data":{"disabled":0,"host":"example.com","id":"YXzdB0ZcPZ8daPvRfobqQh6H","name":"FTP backups","passive":1,"path":"","port":21,"timeout":30,"type":"FTP","upload_system_backup":0,"username":"backup_daemon"},"metadata":{"command":"backup_destination_get","reason":"OK","result":1,"version":1}}},"google":{"summary":"type=GoogleDrive","value":{"data":{"client_id":"CientID","client_secret":"backups3crets","disabled":0,"folder":"","id":"N9jC0iMGNbDwIph7m0MfkDd4","name":"Googlyness","timeout":30,"type":"GoogleDrive","upload_system_backup":0},"metadata":{"command":"backup_destination_get","reason":"OK","result":1,"version":1}}},"local":{"summary":"type=Local","value":{"data":{"disabled":0,"id":"SenJqhJKEEE3rPM4XO7dfBaj","mount":0,"name":"additional local","no_mount_fail":0,"path":"/backup","type":"Local","upload_system_backup":0},"metadata":{"command":"backup_destination_get","reason":"OK","result":1,"version":1}}},"rsync":{"summary":"type=Rsync","value":{"data":{"authtype":"password","disabled":0,"host":"example.com","id":"xOL7IT7cwJhGYYra09hrPU1r","name":"rsync","path":"","port":22,"timeout":30,"type":"Rsync","upload_system_backup":0,"username":"scott_bacula"},"metadata":{"command":"backup_destination_get","reason":"OK","result":1,"version":1}}},"s3compatable":{"summary":"type=S3Compatable","value":{"data":{"aws_access_key_id":"563DFGHCVD","bucket":"thepail","disabled":0,"folder":"","host":"osdc.rcc.example.com","id":"68UUM_lypmgTi9_fEaG9MIvY","name":"s3Compatable","timeout":30,"type":"S3Compatible","upload_system_backup":0},"metadata":{"command":"backup_destination_get","reason":"OK","result":1,"version":1}}},"sftp":{"summary":"type=SFTP","value":{"data":{"authtype":"key","disabled":0,"host":"example.com","id":"OD5CeyEbHMEmDe0dqhtO3KYl","name":"SFTPBACKUP","path":"","port":22,"privatekey":"/root/.ssh/the_rsa","timeout":30,"type":"SFTP","upload_system_backup":0,"username":"scott_bacula"},"metadata":{"command":"backup_destination_get","reason":"OK","result":1,"version":1}}},"webdav":{"summary":"type=WebDAV","value":{"data":{"disabled":0,"host":"example.com","id":"ZlSBGjZEr3HVIqhqsdVgWYOM","name":"WebDav","path":"","port":8443,"ssl":1,"timeout":30,"type":"WebDAV","upload_system_backup":0,"username":"scot_bacula"},"metadata":{"command":"backup_destination_get","reason":"OK","result":1,"version":1}}}},"schema":{"properties":{"data":{"$ref":"#/components/schemas/BackupDestinationGetResponse"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_destination_get","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return a backup destination's settings","tags":["Backups","Backup Destination"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_destination_get \\\n id='0W1ei2rd3A4lI5sT6he7Be8st'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_get?api.version=1&id=0W1ei2rd3A4lI5sT6he7Be8st"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/backup_destination_set":{"post":{"description":"Use this function to edit a backup destination's settings.","operationId":"backup_destination_set","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/BackupDestinationSetParameterType"}}},"description":"The destination settings.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_destination_set","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update backup destination settings","tags":["Backups","Backup Destination"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --input=json --output=jsonpretty \\\n backup_destination_set\n"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/json-api/backup_destination_set HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 0\n\n"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/backup_does_client_id_have_google_credentials":{"get":{"description":"This function returns whether a Google Drive™ client ID credential file exists.","operationId":"backup_does_client_id_have_google_credentials","parameters":[{"description":"The user's Google Drive client ID.","in":"query","name":"client_id","required":true,"schema":{"example":"aBcdeFgHIjK123","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"exists":{"description":"Whether Google credentials exist for the Google Drive client ID.\n\n* `1` — Google Drive credentials exist.\n* `0` — Google Drive credentials do **not** exist.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_does_client_id_have_google_credentials","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Google Drive™ client ID credentials","tags":["Backups","Backup Destination"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_does_client_id_have_google_credentials \\\n client_id='aBcdeFgHIjK123'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_does_client_id_have_google_credentials?api.version=1&client_id=aBcdeFgHIjK123"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"68"}},"/backup_list_transported":{"get":{"description":"This function lists backup files that the system sent through a specified additional backup transport.","operationId":"backup_list_transported","parameters":[{"description":"The transport ID.\n\nIf you do not specify this parameter, the function returns backup information for all transports.\n\n**Note:**\n\nYou may obtain the IDs for all configured transports by calling WHM API 1's `backup_destination_list` function.","in":"query","name":"transport","required":false,"schema":{"example":"nN04BhzirlJUNSLSBXSMBEYG","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"remote_backups":{"additionalProperties":{"additionalProperties":{"description":"An array containing information on one account's backups for a given transport.\n\nThe property name is a cPanel account on the server.\n\nEach array element is a date.","items":{"description":"","example":"2018-07-19T00:00:00.000Z","format":"ISO-8601 Date","type":"string"},"type":"array"},"description":"An object containing details of accounts whose backups the system sent through a transport.\n\nThe property name is a backup transport ID, an automatically generated random string.","type":"object"},"description":"An object containing the backup destination information.","example":{"nN04BhzirlJUNSLSBXSMBEYG":{"janedoe":["2020-08-28T00:00:00.000Z","2020-08-31T00:00:00.000Z","2020-09-02T00:00:00.000Z"]}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_list_transported","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return backup files sent through transport","tags":["Backups","Backup or Restore"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_list_transported\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_list_transported?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"76"}},"/backup_destination_validate":{"get":{"description":"This function validates a backup destination.","operationId":"backup_destination_validate","parameters":[{"description":"The destination's ID.","in":"query","name":"id","required":true,"schema":{"example":"0W1ei2rd3A4lI5sT6he7Be8st","type":"string"}},{"description":"Whether to disable the backup destination if validation fails.\n\n* `1` — Disable.\n* `0` — Do **not** disable.","in":"query","name":"disableonfail","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"id":{"description":"The destination's ID.","example":"0W1ei2rd3A4lI5sT6he7Be8st","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_destination_validate","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate a backup destination","tags":["Backups","Backup Destination"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_destination_validate \\\n id='0W1ei2rd3A4lI5sT6he7Be8st' \\\n disableonfail='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_validate?api.version=1&id=0W1ei2rd3A4lI5sT6he7Be8st&disableonfail=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/backup_generate_google_oauth_uri":{"get":{"description":"This function generates a\n[Google Drive™ OAuth redirect URI](https://developers.google.com/identity/protocols/OAuth2InstalledApp).","operationId":"backup_generate_google_oauth_uri","parameters":[{"description":"The Google Drive client ID.","in":"query","name":"client_id","required":true,"schema":{"example":"aBcdeFgHIjK123","type":"string"}},{"description":"The Google Drive\n[client secret](https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/).","in":"query","name":"client_secret","required":true,"schema":{"example":"aBcde123FgHIjK456","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"uri":{"description":"The generated Google Drive OAuth redirect URI.","example":"https://accounts.google.com/o/oauth2/auth?client_id=aBcdeFgHIjK123&response_type=code&redirect_uri=https%3A%2F%2Fhost-10-0-0-2.example.tld%3A2087%2Fgoogledriveauth%2Fcallback&scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fdrive.file&access_type=offline&prompt=consent&state=IkdLqOej5CLPW1nHRF6OJYaahE7HPXrRUvpFs6MhmBMbCjvWDQcstyYhbUFge5IJ","format":"uri","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_generate_google_oauth_uri","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create Google Drive™ OAuth redirect URI","tags":["Backups","Backup Destination"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_generate_google_oauth_uri \\\n client_id='aBcdeFgHIjK123' \\\n client_secret='aBcde123FgHIjK456'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_generate_google_oauth_uri?api.version=1&client_id=aBcdeFgHIjK123&client_secret=aBcde123FgHIjK456"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"68"}},"/backup_destination_list":{"get":{"description":"This function lists backup destinations.","operationId":"backup_destination_list","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"destination_list":{"description":"An array of objects containing backup destination information.","items":{"$ref":"#/components/schemas/BackupDestinationResponseType"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_destination_list","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return a list of backup destinations","tags":["Backups","Backup Destination"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_destination_list\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_list?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/backup_set_list_combined":{"get":{"description":"This function lists locally-stored and backup-destination stored backup files for the server's accounts.","operationId":"backup_set_list_combined","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"backup_set":{"additionalProperties":{"description":"An array of objects containing the cPanel account's backup file information.\n\n**Note:**\n\nThis return name is the cPanel account's name.","format":"username","items":{"description":"An object containing the time and location backup information.","properties":{"when":{"description":"The date the backup was created.","example":"2020-09-01T00:00:00.000Z","format":"ISO-8601 Date","type":"string"},"where":{"description":"The location of where the backup is located.\n\n* `local` - A backup located on the local machine.\n* `remote` - A backup located on a remote machine.","enum":["local","remote"],"example":"local","type":"string"}},"type":"object"},"type":"array"},"description":"An object that contains an object of backup destination information.","example":{"cpusername1":[{"when":"2020-01-25T00:00:00.000Z","where":"local"},{"when":"2020-01-26T00:00:00.000Z","where":"local"}],"cpusername2":[{"when":"2020-01-25T00:00:00.000Z","where":"local"},{"when":"2020-01-26T00:00:00.000Z","where":"local"}]},"type":"object"},"destination_legend":{"additionalProperties":{"description":"An object containing the backup destination's name and its transport type.\n\n**Note:**\n\nThis return's name is the destination's identification string.","properties":{"name":{"description":"The backup destination's name.","example":"More Backups","type":"string"},"type":{"description":"The type of backup destination used in the configuration.\n\n* `AmazonS3`\n* `Backblaze`\n* `Custom`\n* `FTP`\n* `GoogleDrive`\n* `Local`\n* `Rsync`\n* `S3Compatible`\n* `SFTP`\n* `WebDAV`","enum":["AmazonS3","Backblaze","Custom","FTP","GoogleDrive","Local","Rsync","S3Compatible","SFTP","WebDAV"],"example":"Local","type":"string"}},"type":"object"},"description":"An object containing objects that contain the backup's destination and type information.","example":{"GLT1vFsVO8cqk2UWWFpJ9kSQ":{"name":"More Backups","type":"Local"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_set_list_combined","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return backup files for the server's accounts","tags":["Backups","Backup or Restore"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_set_list_combined\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_set_list_combined?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"80"}},"/backup_skip_users_all":{"get":{"description":"This function enables and disables the backup and legacy backups.","operationId":"backup_skip_users_all","parameters":[{"description":"Whether to enable the backup type that the `backupversion` parameter\nspecifies for all users.\n * `1` - Enable.\n * `0` - Disable.","in":"query","name":"state","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"The type of backup.\n * `backup` - Standard backups.\n * `legacy` - Legacy backups.","in":"query","name":"backupversion","required":true,"schema":{"enum":["backup","legacy"],"example":"backup","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_skip_users_all","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result`\nfield is `0`. This field may display a success message when\na function succeeds.","example":"Configuration update process started","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable or disable backups","tags":["Backups","Backup Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_skip_users_all \\\n state='1' \\\n backupversion='backup'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_skip_users_all?api.version=1&state=1&backupversion=backup"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/backup_skip_users_all_status":{"get":{"description":"This function checks each user's backup configuration status while the `backup_skip_users_all` function runs.","operationId":"backup_skip_users_all_status","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"reason":{"description":"An object that contains backup configuration status information.","properties":{"msg":{"description":"The function's status.","example":"Done","type":"string"},"perc":{"description":"The percentage of users whose backup status has changed.","example":100,"maximum":100,"minimum":0,"type":"integer"},"running":{"description":"Whether user configuration changes are still in progress.\n\n* `1` - In Progress.\n* `0` - Finished.","enum":[0,1],"example":0,"type":"integer"}},"type":"object"}}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_skip_users_all_status","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK."},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return backup configuration status","tags":["Backups","Backup Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_skip_users_all_status\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_skip_users_all_status?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/backup_user_list":{"get":{"description":"This function lists users with a backup file, stored locally or on additional backup destinations, on a specified date.","operationId":"backup_user_list","parameters":[{"description":"The desired date.","in":"query","name":"restore_point","required":true,"schema":{"example":"2014-10-10T00:00:00.000Z","format":"ISO-8601 Date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"user":{"description":"An array of objects containing user backup information.","items":{"properties":{"status":{"description":"The account's backup status\n* `active`\n* `inactive`\n* `no_backup`","enum":["active","inactive","no_backup"],"example":"active","type":"string"},"username":{"description":"The user's username.","example":"username","format":"username","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_user_list","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return users with a backup file","tags":["Backups","Backup Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_user_list \\\n restore_point='2014-10-10T00:00:00.000Z'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_user_list?api.version=1&restore_point=2014-10-10T00%3a00%3a00.000Z"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/convert_and_migrate_from_legacy_config":{"get":{"description":"This function converts and migrates a server from the Legacy Backup system to the Backup system.","operationId":"convert_and_migrate_from_legacy_config","parameters":[{"description":"Whether to convert the server from the Legacy Backup system to\nthe Backup system.\n * `1` — Convert.\n * `0` — Do **not** convert.","in":"query","name":"no_convert","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"convert_and_migrate_from_legacy_config","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Legacy Backup configuration was renamed from /etc/cpbackup.conf to /etc/cpbackup.conf-1485958451 as a backup copy for your records.","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Migrate server to new backup system","tags":["Backups","Legacy Migration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n convert_and_migrate_from_legacy_config\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_and_migrate_from_legacy_config?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"64"}},"/fetch_pkgacct_master_log":{"get":{"description":"This function returns the contents of a `start_background_pkgacct` session's master log file.","operationId":"fetch_pkgacct_master_log","parameters":[{"description":"The `start_background_pkgacct` session ID.","in":"query","name":"session_id","required":true,"schema":{"example":"username20200323154328kDJ2Kx4xua2KtG","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"log":{"description":"The master log file's contents.","example":"{\"contents\":\"pkgacct started.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"partial\":0,\"contents\":\"pkgacct version 10 - user : username - tarball: 1 - target mysql : 5.7 - split: 1 - incremental: 0 - homedir: 0 - mailman: 1 - backup: 0 - archive version: 4 - running with uid 0\\n\",\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"partial\":0,\"contents\":\"pkgacct using ''/usr/local/cpanel/3rdparty/bin/pigz -6 --processes 1 --blocksize 4096 --rsyncable'' to compress archives\\n\"}\n{\"type\":\"out\",\"indent\":0,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"contents\":\"pkgacct -- attempting to use daily backup to create an account package\\n\",\"pid\":4073}\n{\"indent\":0,\"contents\":\"pkgacct -- could not use daily backup because no daily incremental backup for user username can be found ( check if daily incremental backups are enabled )\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"pid\":4073,\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"contents\":\"pkgacct working dir : /home/cpmove-username\",\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"contents\":\"Copying Reseller Config...\",\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"partial\":1}\n{\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"partial\":0,\"contents\":\"Done\\n\",\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"partial\":1,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"contents\":\"Copying Suspension Info (if needed)...\"}\n{\"type\":\"out\",\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"partial\":0,\"contents\":\"Done\\n\",\"pid\":4073,\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"contents\":\"Copying installed SSL certificates and keys...\",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:28 -0500\"}\n{\"type\":\"out\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:28 -0500\",\"contents\":\"Performing ApacheTLS component....\",\"pid\":4073,\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"contents\":\"Completed ApacheTLS component.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073}\n{\"type\":\"out\",\"pid\":4073,\"contents\":\"Done\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"indent\":0}\n{\"indent\":0,\"contents\":\"Copying DKIM keys....\",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"contents\":\"Done\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073}\n{\"type\":\"out\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"contents\":\"Copying Bandwidth Data....\",\"pid\":4073,\"indent\":0}\n{\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Performing Bandwidth component....\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"contents\":\"Summary databases \",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"indent\":0}\n{\"type\":\"out\",\"contents\":\" done!\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"indent\":0}\n{\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Completed Bandwidth component.\\n\",\"type\":\"out\"}\n{\"indent\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Done\\n\",\"pid\":4073,\"type\":\"out\"}\n{\"type\":\"out\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"contents\":\"Copying Dns Zones....\",\"pid\":4073,\"indent\":0}\n{\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"contents\":\"...username.tld...\",\"type\":\"out\"}\n{\"indent\":0,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Done\\n\",\"pid\":4073,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"contents\":\"Copying Mail files....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1}\n{\"indent\":0,\"contents\":\"Done\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"type\":\"out\"}\n{\"contents\":\"Copying proftpd file....\",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"contents\":\"Done\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"type\":\"out\"}\n{\"indent\":0,\"contents\":\"Performing Logs component....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"contents\":\"...log file sizes [0 byte(s)]...\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"contents\":\"...username.tld-ssl_log...\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1}\n{\"contents\":\"...username.tld...\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"contents\":\"Completed Logs component.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"contents\":\"Copy userdata...\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"pid\":4073}\n{\"contents\":\"Done\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"contents\":\"Copy custom virtualhost templates...\",\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Done\\n\",\"pid\":4073}\n{\"type\":\"out\",\"contents\":\"Copying mailman lists and archives....\",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"contents\":\"Done copying mailman lists and archives.\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1}\n{\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Performing Postgresql component....\",\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"contents\":\"Completed Postgresql component.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Performing Mysql component....\",\"indent\":0}\n{\"contents\":\"Determining mysql dbs...\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"contents\":\"...mysqldump version: 5.7.27...\",\"indent\":0}\n{\"type\":\"out\",\"contents\":\"...mysql version: 5.7...\",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"contents\":\"Saving mysql privs...\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"pid\":4073}\n{\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Done\\n\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"contents\":\"Storing MySQL databases...\\n\",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Done\\n\",\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"...Done\\n\"}\n{\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"...Done\\n\",\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Completed Mysql component.\\n\"}\n{\"indent\":0,\"contents\":\"Performing MysqlRemoteNotes component....\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"type\":\"out\"}\n{\"indent\":0,\"contents\":\"Completed MysqlRemoteNotes component.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"type\":\"out\"}\n{\"pid\":4073,\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Copying cpuser file.......\",\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"contents\":\"Done\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073}\n{\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Copying crontab file.......\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"contents\":\"Done\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"contents\":\"Performing Quota component....\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"indent\":0}\n{\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Completed Quota component.\\n\",\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Performing Integration component....\",\"pid\":4073}\n{\"pid\":4073,\"contents\":\"Completed Integration component.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"contents\":\"Performing AuthnLinks component....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"contents\":\"Completed AuthnLinks component.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Performing APITokens component....\"}\n{\"indent\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Completed APITokens component.\\n\",\"pid\":4073,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Performing DNSSEC component....\",\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Completed DNSSEC component.\\n\",\"pid\":4073}\n{\"type\":\"out\",\"indent\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Performing Custom component....\",\"pid\":4073}\n{\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"No custom components to perform.\\n\",\"indent\":0,\"type\":\"out\"}\n{\"contents\":\"Completed Custom component.\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"contents\":\"Performing AutoSSL component....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0}\n{\"indent\":0,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Completed AutoSSL component.\\n\",\"pid\":4073,\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"contents\":\"Storing Subdomains....\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Done\\n\",\"pid\":4073}\n{\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Storing Parked Domains....\\n\",\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"contents\":\"Done\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"indent\":0}\n{\"indent\":0,\"contents\":\"Storing Addon Domains....\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"type\":\"out\"}\n{\"contents\":\"Performing Password component....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"indent\":0,\"contents\":\"Completed Password component.\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073}\n{\"type\":\"out\",\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Performing DigestShadow component....\",\"indent\":0}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Completed DigestShadow component.\\n\"}\n{\"type\":\"out\",\"indent\":0,\"contents\":\"Copying shell.......\",\"partial\":1,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073}\n{\"type\":\"out\",\"indent\":0,\"pid\":4073,\"contents\":\"Done\\n\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0}\n{\"indent\":0,\"pid\":4073,\"contents\":\"Performing PublicContact component....\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Completed PublicContact component.\\n\",\"type\":\"out\"}\n{\"contents\":\"Performing MailLimits component....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"Completed MailLimits component.\\n\",\"pid\":4073,\"type\":\"out\"}\n{\"contents\":\"Performing LinkedNodes component....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Completed LinkedNodes component.\\n\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"pid\":4073,\"contents\":\"Creating Archive ....\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":1,\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"\\n\",\"type\":\"out\"}\n{\"contents\":\"splitpkgacctfile is: /home/cpmove-username-split/cpmove-username.tar.gz.part00001\\n\",\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"pid\":4073,\"indent\":0,\"type\":\"out\"}\n{\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"\\nsplitmd5sum is: e06a2d1f0cb499cb1d5ff15116f02df4\\n\",\"indent\":0,\"type\":\"out\"}\n{\"type\":\"out\",\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"\\nsplitsize is: 7275\\n\",\"indent\":0}\n{\"type\":\"out\",\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"Done\\n\",\"pid\":4073,\"indent\":0}\n{\"pid\":4073,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"partial\":0,\"contents\":\"\\nmysqlsize is: 0\\n\",\"indent\":0,\"type\":\"out\"}\n{\"indent\":0,\"pid\":4073,\"partial\":0,\"timestamp\":\"2020-03-23 10:43:29 -0500\",\"contents\":\"pkgacct completed\\n\",\"type\":\"out\"}","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"fetch_pkgacct_master_log","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return start_background_pkgacct session log file","tags":["Backups","Backup or Restore"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n fetch_pkgacct_master_log \\\n session_id='username20200323154328kDJ2Kx4xua2KtG'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_pkgacct_master_log?api.version=1&session_id=username20200323154328kDJ2Kx4xua2KtG"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"88"}},"/backup_set_list":{"get":{"description":"This function lists backup files for the server's accounts in the local disk.","operationId":"backup_set_list","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"backup_set":{"description":"hash of a user's backup information. This hash includes the user and backup_date returns.","items":{"properties":{"backup_date":{"description":"The backup file's date. A date in YYYY-MM-DD format, where:- YYYY represents the year.\n- MM represents the month.\n- DD represents the day.","items":{"example":"2014-01-01T00:00:00.000Z","type":"string"},"type":"array"},"user":{"description":"The backup file set's owner. A valid username.","example":"username","type":"string"}},"type":"object"},"properties":{},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_set_list","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return backup files in the local disk","tags":["Backups","Backup or Restore"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_set_list\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_set_list?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/get_pkgacct_session_state":{"get":{"description":"This function returns the state of a `start_background_pkgacct` session.","operationId":"get_pkgacct_session_state","parameters":[{"description":"The `start_background_pkgacct` session ID.","in":"query","name":"session_id","required":true,"schema":{"example":"username20200323154328kDJ2Kx4xua2KtG","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"state":{"description":"The `start_background_pkgacct` session's state.\n* `COMPLETED`\n* `FAILED`\n* `RUNNING`","enum":["COMPLETED","FAILED","RUNNING"],"example":"COMPLETED","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_pkgacct_session_state","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result`\nfield is `0`. This field may display a success message when\na function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return start_background_pkgacct session state","tags":["Backups","Backup or Restore"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_pkgacct_session_state \\\n session_id='username20200323154328kDJ2Kx4xua2KtG'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_pkgacct_session_state?api.version=1&session_id=username20200323154328kDJ2Kx4xua2KtG"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"88"}},"/get_users_and_domains_with_backup_metadata":{"get":{"description":"This function lists all users and their domains that have backup metadata.","operationId":"get_users_and_domains_with_backup_metadata","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"additionalProperties":{"description":"The cPanel user account's associated domain.","example":"example.com","format":"domain","type":"string"},"description":"Keys are cPanel user accounts that contain backup metadata.","example":{"username":"example.com","username2":"example.net","username3":"example.org"},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_users_and_domains_with_backup_metadata","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return users and domains with backup metadata","tags":["Backups","Backup or Restore"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_users_and_domains_with_backup_metadata\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_users_and_domains_with_backup_metadata?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"74"}},"/get_users_with_backup_metadata":{"get":{"description":"This function lists users with backup metadata.","operationId":"get_users_with_backup_metadata","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"accounts":{"description":"The cPanel user accounts on the server that contain backup metadata.","items":{"example":"username","format":"username","type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_users_with_backup_metadata","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return users with backup metadata","tags":["Backups","Backup or Restore"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_users_with_backup_metadata\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_users_with_backup_metadata?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"70"}},"/list_cparchive_files":{"get":{"description":"This function lists all available cparchive files.\n\n**Note:**\n\n* `MM.DD.YYYY` represents the file's date in month, date, and year format.\n* `HH-MM-SS` represents the file's timestamp in hour, minute, and second format.\n\nThe function checks the following filenames, where `USER` represents the cPanel account's filusername::\n* `cpmove-USER`\n* `cpmove-USER.tar`\n* `cpmove-USER.tar.gz`\n* `USER.tar`\n* `USER.tar.gz`\n* `backup-{MM.DD.YYYY}{HH-MM-SS}{USER}.tar`\n* `backup-{MM.DD.YYYY}{HH-MM-SS}{USER}.tar.gz`\n\nThe function checks for these filenames in the following locations:\n* `/home`\n* `/home2`\n* `/home3`\n* `/root`\n* `/usr`\n* `/usr/home`\n* `/web`","operationId":"list_cparchive_files","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"quickrestore_files":{"description":"An array of objects that contains information about each `cparchive` file.","items":{"properties":{"file":{"description":"The backup file's name in one of the formats listed above.","example":"cpmove-username1.tar.gz","type":"string"},"path":{"description":"The backup file's directory in one of the locations listed above.","example":"/home","type":"string"},"user":{"description":"The backup file's account.","example":"username","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_cparchive_files","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cparchive files list","tags":["Backups","Backup or Restore"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_cparchive_files\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_cparchive_files?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.42"}},"/restore_queue_activate":{"get":{"description":"This function activates the restore queue. This triggers a process that restores all queued accounts.","operationId":"restore_queue_activate","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_queue_activate","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Restore queue processing initiated","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Start restoration","tags":["Account Restoration","Restore Queue Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restore_queue_activate\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_activate?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/restore_queue_add_task":{"get":{"description":"This function restores a user's cPanel account from a backup file.","operationId":"restore_queue_add_task","parameters":[{"description":"The cPanel account's username.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}},{"description":"The date of the backup to use, in `YYYY-MM-DD` format.","in":"query","name":"restore_point","required":true,"schema":{"example":"2019-10-21T00:00:00.000Z","type":"string"}},{"description":"Whether to assign the account a dedicated IP address.\n\n* `1` — Assign a dedicated IP address.\n* `0` — Use the shared IP address.","in":"query","name":"give_ip","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to restore the account's MySQL® databases.\n\n* `1` — Restore.\n* `0` — Do **not** restore.","in":"query","name":"mysql","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to restore the account's subdomains.\n\n* `1` — Restore.\n* `0` — Do **not** restore.","in":"query","name":"subdomains","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to restore the account's email configuration.\n\n* `1` — Restore.\n* `0` — Do **not** restore.","in":"query","name":"mail_config","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The destination's identification string.\n\n* `local` — The local directory.\n* The destination ID string's value.","in":"query","name":"destid","required":false,"schema":{"default":"local","example":"LmTZCUpqqLSPH8AO7pVtIeNK","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"queue_id":{"description":"The process's internal task queue ID.","example":"3b99QG5fp99tdL5","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_queue_add_task","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Restore user account from backup","tags":["Account Restoration","Restore Account"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restore_queue_add_task \\\n user='username' \\\n restore_point='2019-10-21T00:00:00.000Z'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_add_task?api.version=1&user=username&restore_point=2019-10-21T00%3a00%3a00.000Z"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/restore_queue_clear_all_completed_tasks":{"get":{"description":"This function removes successfully completed tasks from the restoration queue.","operationId":"restore_queue_clear_all_completed_tasks","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_queue_clear_all_completed_tasks","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove all completed restoration tasks","tags":["Account Restoration","Restore Queue Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restore_queue_clear_all_completed_tasks\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_clear_all_completed_tasks?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/restore_queue_clear_all_failed_tasks":{"get":{"description":"This function removes any failed tasks from the restoration queue.","operationId":"restore_queue_clear_all_failed_tasks","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_queue_clear_all_failed_tasks","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove all failed restoration tasks","tags":["Account Restoration","Restore Queue Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restore_queue_clear_all_failed_tasks\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_clear_all_failed_tasks?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/restore_queue_clear_all_pending_tasks":{"get":{"description":"This function removes any pending tasks from the restoration queue.","operationId":"restore_queue_clear_all_pending_tasks","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_queue_clear_all_pending_tasks","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove all pending restoration tasks","tags":["Account Restoration","Restore Queue Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restore_queue_clear_all_pending_tasks\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_clear_all_pending_tasks?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/restore_queue_clear_all_tasks":{"get":{"description":"This function removes all tasks from the restoration queue.","operationId":"restore_queue_clear_all_tasks","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_queue_clear_all_tasks","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove all restoration tasks","tags":["Account Restoration","Restore Queue Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restore_queue_clear_all_tasks\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_clear_all_tasks?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/restore_queue_clear_completed_task":{"get":{"description":"This function removes a single completed task from the restoration queue.","operationId":"restore_queue_clear_completed_task","parameters":[{"description":"The cPanel account's username.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"When the restoration queue started the restoration.","in":"query","name":"start_time","required":true,"schema":{"example":1396065600,"format":"unix_timestamp","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_queue_clear_completed_task","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove completed restoration task","tags":["Account Restoration","Restore Queue Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restore_queue_clear_completed_task \\\n user='username' \\\n start_time='1396065600'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_clear_completed_task?api.version=1&user=username&start_time=1396065600"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/restore_queue_clear_pending_task":{"get":{"description":"This function removes a single pending task from the restoration queue.","operationId":"restore_queue_clear_pending_task","parameters":[{"description":"The cPanel account's username.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_queue_clear_pending_task","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove pending restoration task","tags":["Account Restoration","Restore Queue Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restore_queue_clear_pending_task \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_clear_pending_task?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/restore_queue_is_active":{"get":{"description":"This function checks whether the system's restoration queue is actively processing tasks.","operationId":"restore_queue_is_active","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"is_active":{"description":"Whether the restoration queue is actively processing tasks.\n\n* `1` — Currently active.\n* `0` — **Not** currently active.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_queue_is_active","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate restoration queue is active","tags":["Account Restoration","Restore Queue Reporting"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restore_queue_is_active\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_is_active?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/restore_queue_list_active":{"get":{"description":"This function lists the tasks that the restoration queue is actively processing.","operationId":"restore_queue_list_active","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"restore_job":{"description":"An array of objects that contain information about an active task in the restoration queue.","items":{"properties":{"options":{"description":"A list of information about an active task in the restoration queue.","properties":{"destid":{"description":"The backup location from which to restore the data.","example":"local","type":"string"},"give_ip":{"description":"Whether the task will assign the account a dedicated IP address.\n\n* `1` — Assign.\n* `0` — Will **not** assign.","enum":[0,1],"example":1,"type":"integer"},"mail_config":{"description":"Whether the function will restore the account's email configuration.\n\n* `1` — Restore.\n* `0` — Will **not** restore.","enum":[0,1],"example":1,"type":"integer"},"mysql":{"description":"Whether the task will restore the account's MySQL® databases.\n\n* `1` — Restore.\n* `0` — Will **not** restore.","enum":[0,1],"example":1,"type":"integer"},"subdomains":{"description":"Whether the function will restore the account's subdomains.\n\n* `1` — Restore.\n* `0` — Will **not** restore.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"restore_point":{"description":"The date of the backup that the task will use, in `YYYY-MM-DD` format.","example":"2019-10-21T00:00:00.000Z","format":"ISO-8601 Date","type":"string"},"user":{"description":"The cPanel account's username.","example":"username","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_queue_list_active","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return active restoration tasks list","tags":["Account Restoration","Restore Queue Reporting"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restore_queue_list_active\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_list_active?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/restore_queue_list_completed":{"get":{"description":"This function lists the restoration queue's completed tasks.\n\n**Important:**\n\nThis function's output varies dramatically. The [`/usr/local/cpanel/bin/backup_restore_manager`](https://go.cpanel.net/backuprestoremanagerscript) script run with the `list_finished` option determines this output..\n\n**Note:**\n\nOn servers that run CentOS 7, you may see a `named` warning about the absence of SPF resource records on DNS.\n * This warning is **not** relevant on CentOS 7 servers, because [RFC 7208](https://tools.ietf.org/html/rfc7208) deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.\n * Red Hat 7.1 and CentOS 7.1 both contain `bind-9.9.4-23.el7`, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the [Red Hat Bugzilla case about SPF record errors](https://bugzilla.redhat.com/show_bug.cgi?id=1215164).","operationId":"restore_queue_list_completed","parameters":[],"responses":{"200":{"content":{"application/json":{"examples":{"restore_queue_add_task_function":{"description":"A task that the restore_queue_add_task function added.","value":{"data":{"restore_job":[{"restore_job":{"options":{"destid":"local","give_ip":0,"mail_config":0,"mysql":0,"subdomains":0},"restore_point":"2020-03-29","user":"mrfrog"},"status_info":{"altered_items":null,"dangerous_items":null,"finished":"1586188203","log":"warning","restore_logfile":"item-RESTORE_AccountLocal_mrfrog","result":2,"skipped_items":null,"started":"1586188078","status":2,"statusmsg":"warning","transfer_session_id":"userbackup20200406154758JqBa","warnings":null}}]},"metadata":{"command":"restore_queue_list_completed","reason":"OK","result":1,"version":1}}},"restorepkg":{"description":"A task that the /scripts/restorepkg script added.","value":{"data":{"restore_job":[{"restore_job":{"options":{"give_ip":0,"mail_config":1,"mysql":1,"subdomains":1},"restore_point":"YYYY-MM-DD","user":"example"},"status_info":{"finished":"1355840823","log":"Extracting Domain....Done\n Done\n\n Restoring cpanel user config file Done\n\n Restoring reseller packages and features (if any)\n Restoring reseller privs (if any)\n Restoring Locale Setting\n Restoring SSL keys and Certificates Done\n\n Restoring frontpage (if installed) Done\n\n Restoring access logs.... Done\n\n Restoring domain keys.... Done\n\n Restoring MySQL databases.... Database \"cptmpdb_azri8qf8_0KuzT3yEH7JFeeSi\" dropped Done\n Successful creation of roundcube cp_schema_version table\nInitial run through schema migration: from '0.2b' to '0.8.4'\nPlease ignore non-fatal warnings, such as duplicate keys, columns, indexes, or tables already existing. \nSuccessfully saved version 0.8.4 to cp_schema_version table\nDBD::mysql::st execute failed: Table 'cptmpdb_azri8qf8_7WIKvg175f2M02yn.users' doesn't exist at /usr/local/cpanel/Cpanel/Email/RoundCube/DBI.pm line 503, line 1. DBD::mysql::st execute failed: Table 'cptmpdb_azri8qf8_7WIKvg175f2M02yn.users' doesn't exist at /usr/local/cpanel/Cpanel/Email/RoundCube/DBI.pm line 503, line 1. Transfer failed from temp database to Roundcube database.\n Done\n Done\n Restoring MySQL privs Done\n\n Reloading MySQL Done\n\nRestoring PostgreSQL databases.... ERROR: role \"azri8qf8\" already exists Restoring PostgreSQL privs Done\n\n Restoring Mailman lists Done\n\n Restoring Mailman Archives Done\n\n Restoring shell Current shell /usr/local/cpanel/bin/noshell is up to date. Done\n\n Restoring password Password for azri8qf8 has been changed Done\n\n Restoring proftpd file Done\n\n Resyncing FTP Passwords Updating ftp passwords for azri8qf8Ftp password files updated.Ftp vhost passwords syncedDone\n\n Linking old home directories\n Parsing Domain Databases ...Subdomains......ParkedDomains......AddonDomains... \\n Restoring Domains\n\n Restoring Bandwidth Data Done\n Restoring Counter Data \\n Restoring Homedir.... Done\n\n Doing fileprotect conversion\n Restoring nobody owned files Done\n\n Restoring Mail files Done\n \\n Restoring userdata.... Done\n\n Restoring custom virtualhost templates....\n Converting email to cPanel 5+ (if needed) Done\n\n Cleaning up filters (if needed) vfilter converter v3.0Updating vfilter files to latest format.Running for azri8qf8 only (force=0) (has_spam_acl=0)Processing azri8qf8......DoneDone\n \\n Fixing mail permissions Done\n\n Restoring crontab Done\n Converting to maildir if needed Done\n Restoring Dns Zones Restoring zone: 28-ps1n25d.test.db Zone updates: 28-ps1n25d.test\n Adding missing subdomain DNS entries (if needed) \\n Update Proxy subomains Adding proxy subdomains for domain 28-ps1n25d.test.28-ps1n25d.test [28-ps1n25d.test, 10.215.215.229, no changes needed]Done\n\n Updating SPF Records Done\n\n Restoring quota Done\n \\n\n Update mail routing LOCAL MAIL EXCHANGER: This server will serve as a primary mail exchanger for 28-ps1n25d.test's mail.: This configuration has been manually selected. Done\n\n Rebuilding Apache Conf Built /usr/local/apache/conf/httpd.conf OK\n Restore Complete Account Restore Complete Unlocking password for user azri8qf8.passwd: Success.\n","result":1,"started":"1355840811"}},{"restore_job":{"options":{"give_ip":1,"mail_config":0,"mysql":1,"subdomains":0},"restore_point":"YYYY-MM-DD","user":"bcow"},"status_info":{"finished":"1355840823","log":"","result":0,"started":"1355840823"}}]},"metadata":{"command":"restore_queue_list_completed","reason":"OK","result":1,"version":1}}}},"schema":{"properties":{"data":{"properties":{"restore_job":{"description":"An array of objects that contain information about a completed task in the restoration queue.","items":{"properties":{"restore_job":{"description":"An object that contains the task's settings.","properties":{"options":{"description":"An object that contains information about the task's options.","properties":{"destid":{"description":"The destination's identification string.\n* `local` — The local directory.\n* The destination ID string's value.","example":"LmTZCUpqqLSPH8AO7pVtIeNK","type":"string"},"give_ip":{"description":"Whether the task assigned the account a dedicated IP address.\n* `1` - Assigned.\n* `0` - Did **not** assign.","enum":[0,1],"example":1,"type":"integer"},"mail_config":{"description":"Whether the function restored the account's email configuration.\n* `1` - Restored.\n* `0` - Did **not** restore.","enum":[0,1],"example":1,"type":"integer"},"mysql":{"description":"Whether the task restored the account's MySQL® databases.\n* `1` - Restored.\n* `0` - Did **not** restore.","enum":[0,1],"example":1,"type":"integer"},"subdomains":{"description":"Whether the function restored the account's subdomains.\n* `1` - Restored.\n* `0` - Did **not** restore.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"restore_point":{"description":"The date of the backup that the task used.","example":"2015-10-21T00:00:00.000Z","format":"ISO-8601 Date","type":"string"},"user":{"description":"The cPanel account's username.","example":"username","format":"username","type":"string"}},"type":"object"},"status_info":{"description":"An object that contains information about the task's status.","properties":{"altered_items":{"description":"The number of items that the restoration process changed.","example":1,"nullable":true,"type":"integer"},"dangerous_items":{"description":"The number of items in the restoration process that may cause problems on the account.","example":1,"nullable":true,"type":"integer"},"finished":{"description":"The time that the restoration process completed this task.","example":"1355840823","format":"unix_timestamp","type":"string"},"log":{"description":"The task's log information.","example":"Extracting Domain....Done Done Restoring cpanel user config file Done Restoring reseller packages and features (if any) Restoring reseller privs (if any) Restoring Locale Setting Restoring SSL keys and Certificates Done Restoring frontpage (if installed) Done Restoring access logs.... Done Restoring domain keys.... Done Restoring MySQL databases.... Database \"cptmpdb_azri8qf8_0KuzT3yEH7JFeeSi\" dropped Done Successful creation of roundcube cp_schema_version table Initial run through schema migration: from '0.2b' to '0.8.4' Please ignore non-fatal warnings, such as duplicate keys, columns, indexes, or tables already existing. Successfully saved version 0.8.4 to cp_schema_version table DBD::mysql::st execute failed: Table 'cptmpdb_azri8qf8_7WIKvg175f2M02yn.users' doesn't exist at /usr/local/cpanel/Cpanel/Email/RoundCube/DBI.pm line 503, line 1. DBD::mysql::st execute failed: Table 'cptmpdb_azri8qf8_7WIKvg175f2M02yn.users' doesn't exist at /usr/local/cpanel/Cpanel/Email/RoundCube/DBI.pm line 503, line 1. Transfer failed from temp database to Roundcube database. Done Done Restoring MySQL privs Done Reloading MySQL Done Restoring PostgreSQL databases.... ERROR: role \"azri8qf8\" already exists Restoring PostgreSQL privs Done Restoring Mailman lists Done Restoring Mailman Archives Done Restoring shell Current shell /usr/local/cpanel/bin/noshell is up to date. Done Restoring password Password for azri8qf8 has been changed Done Restoring proftpd file Done Resyncing FTP Passwords Updating ftp passwords for azri8qf8Ftp password files updated.Ftp vhost passwords syncedDone Linking old home directories Parsing Domain Databases ...Subdomains......ParkedDomains......AddonDomains... Restoring Domains Restoring Bandwidth Data Done Restoring Counter Data Restoring Homedir.... Done Doing fileprotect conversion Restoring nobody owned files Done Restoring Mail files Done Restoring userdata.... Done Restoring custom virtualhost templates.... Converting email to cPanel 5+ (if needed) Done Cleaning up filters (if needed) vfilter converter v3.0Updating vfilter files to latest format.Running for azri8qf8 only (force=0) (has_spam_acl=0)Processing azri8qf8......DoneDone Fixing mail permissions Done Restoring crontab Done Converting to maildir if needed Done Restoring Dns Zones Restoring zone: 28-ps1n25d.test.db Zone updates: 28-ps1n25d.test Adding missing subdomain DNS entries (if needed) Update Proxy subomains Adding proxy subdomains for domain 28-ps1n25d.test.28-ps1n25d.test [28-ps1n25d.test, 10.215.215.229, no changes needed]Done Updating SPF Records Done Restoring quota Done Update mail routing LOCAL MAIL EXCHANGER: This server will serve as a primary mail exchanger for 28-ps1n25d.test's mail.: This configuration has been manually selected. Done Rebuilding Apache Conf Built /usr/local/apache/conf/httpd.conf OK Restore Complete Account Restore Complete Unlocking password for user azri8qf8.passwd: Success.","type":"string"},"restore_logfile":{"description":"The restoration log file's name.","example":"item-RESTORE_AccountLocal_example","type":"string"},"result":{"description":"Whether the task completed successfully.\n* `1` - Success.\n* `0` - Failure.\n* `2` - Warning.","enum":[0,1,2],"example":1,"type":"integer"},"skipped_items":{"description":"The number of items that the restoration process skipped.","example":1,"nullable":true,"type":"integer"},"started":{"description":"The restoration process's start time for this task.","example":"1355840811","format":"unix_timestamp","type":"string"},"transfer_session_id":{"description":"The restoration transfer session's ID.","example":"userbackup20200406154758JqBa","type":"string"},"warnings":{"description":"Any warnings about the restoration process.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_queue_list_completed","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return completed restoration tasks list","tags":["Account Restoration","Restore Queue Reporting"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restore_queue_list_completed\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_list_completed?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/restore_queue_state":{"get":{"description":"This function lists the tasks in the restoration queue.","operationId":"restore_queue_state","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"example":{"active":[{"options":{"give_ip":1,"mail_config":1,"mysql":1,"subdomains":1},"restore_point":"2019-10-21T00:00:00.000Z","user":"username"}],"completed":[{"options":{"give_ip":1,"mail_config":0,"mysql":1,"subdomains":0},"restore_point":"2019-10-22T00:00:00.000Z","user":"username"}],"is_active":1,"pending":[{"options":{"give_ip":0,"mail_config":1,"mysql":0,"subdomains":1},"restore_point":"2019-10-23T00:00:00.000Z","user":"username"}]},"properties":{"active":{"description":"An array of objects containing restoration queue items that the system is actively processing.","items":{"$ref":"#/components/schemas/restorePoint"},"type":"array"},"completed":{"description":"An array of objects containing restoration queue items that the system has already processed.","items":{"$ref":"#/components/schemas/restorePoint"},"type":"array"},"is_active":{"description":"Whether the restoration queue is actively processing a task.\n\n* `1` — The restoration queue is processing a task.\n* `0` — The restoration queue is **not** processing a task.","enum":[0,1],"example":0,"type":"integer"},"pending":{"description":"An array of objects containing restoration queue items that the system will process next.","items":{"$ref":"#/components/schemas/restorePoint"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_queue_state","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return restoration tasks list","tags":["Account Restoration","Restore Queue Reporting"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restore_queue_state\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_state?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/restoreaccount":{"get":{"description":"This function restores an account backup. You can use this function to restore daily,\nweekly, or monthly backups.\n\n**Important:**\n\n* When you call this function, you **must** include at least one of\nthe `all`, `mail`, `subs`, or `mysql` parameters.\n\n* On servers with a custom `Whostmgr::Transfers` module, the function may not return XML\noutput. To properly return XML output, the `Whostmgr::Transfers` module **must** allow\nthe system to use the `Cpanel::Demultiplexer` module to capture output.\n\n**Note:**\n\nOn servers that run CentOS 7, you may see a `named` warning about the absence of SPF\nresource records on DNS.\n\n* This warning is not relevant on CentOS 7 servers, because\n[RFC 7208 deprecated SPF records](https://tools.ietf.org/html/rfc7208).\nCentOS 7 servers use `TXT` records instead of `SPF` records.\n\n* Red Hat 7.1 and CentOS 7.1 both contain `bind-9.9.4-23.el7`, which is an updated\nversion of BIND that complies with RFC 7208. To resolve this issue, update your\noperating system to a version that contains the updated version of BIND. For more\ninformation, read the\n[Red Hat Bugzilla case about SPF record errors](https://bugzilla.redhat.com/show_bug.cgi?id=1215164).","operationId":"restoreaccount","parameters":[{"description":"The account's username.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}},{"description":"The type of backup to restore. The function restores the most recent backup of\nthe type that you specify:\n\n* `monthly`\n* `weekly`\n* `daily`","in":"query","name":"type","required":true,"schema":{"enum":["monthly","weekly","daily"],"example":"monthly","type":"string"}},{"description":"Whether to create the account before restoration.\n\n* `1` — Create and then restore the account. If you select this value and the\naccount already exists, the function will fail.\n* `0` — Restore **only**.","in":"query","name":"all","required":false,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to assign a dedicated IP address to the restored account.\n\n* `1` — Assign a dedicated IP address.\n* `0` — Use the shared IP address.","in":"query","name":"ip","required":false,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to restore account-level filters (vfilters) and forwarders\n(valiases).\n\n* `1` — Restore.\n* `0` — Do **not** restore.","in":"query","name":"mail","required":false,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to restore the account's MySQL® databases.\n\n* `1` — Restore.\n* `0` — Do **not** restore.","in":"query","name":"mysql","required":false,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to restore the account's subdomains.\n\n* `1` — Restore.\n* `0` — Do **not** restore.","in":"query","name":"subs","required":false,"schema":{"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"restoreaccount","type":"string"},"output":{"properties":{"raw":{"description":"An output message that may contain long HTML.","example":"Extracting tarball...................\nDone<br />\nExtracting Domain....Done<br />\nDone<br />\n<br /><br />Restoring cpanel user config fileDone<br />\n<br />Restoring reseller privs (if any)<br />Restoring Locale Setting<br />Restoring SSL keys and CertificatesDone<br />\n<br />Restoring frontpage (if installed)Done<br />\n<br />Restoring access logs....\nDone<br />\n<br /><br />Restoring domain keys....\nDone<br />\n<br /><br />Restoring DB MAP File....\nDone<br />\n<br /><br /><span class=\"b2\">Restoring PostgreSQL databases....</span>\nRestoring PostgreSQL privs<!--\n-->\nDone<br />\n<br />Restoring Mailman listsDone<br />\n<br />Restoring Mailman ArchivesDone<br />\n<br />Restoring shell<blockquote><pre>Current shell /bin/bash is up to date.\n</pre></blockquote>Done<br />\n<br />Restoring password<blockquote><pre></pre></blockquote>Done<br />\n<br />Restoring proftpd fileDone<br />\n<br />Resyncing FTP Passwords<blockquote><pre>Updating ftp passwords for userFtp password files updated.Ftp vhost passwords synced</pre></blockquote>Done<br />\n<br />Linking old home directories<br />Parsing Domain Databases...ParkedDomains......AddonDomains...<br />Restoring Domains<br />\n<br />Restoring Bandwidth DataDone\n<br />Restoring Counter Data<pre></pre><br />Restoring Homedir....<blockquote><pre></pre></blockquote>Done<br />\n<br />Doing fileprotect conversion<br />Restoring nobody owned filesDone<br />\n<br />Restoring Mail filesDone<br />\n<br />Restoring userdata....\nDone<br />\n<br /><br />Restoring custom virtualhost templates....\nConverting email to cPanel 5+ (if needed)<blockquote><pre></pre></blockquote>Done<br />\n<br />Cleaning up filters (if needed)<blockquote><pre>vfilter converter v3.0Updating vfilter files to latest format.Running for user only (force=0) (has_spam_acl=1)Processing user......Done</pre></blockquote>Done<br />\n<br />Fixing mail permissions<blockquote><pre></pre></blockquote>Done<br />\n<br />Restoring crontabDone<br />\nConverting to maildir if needed<blockquote><pre></pre></blockquote>Done<br />\nRestoring Dns Zones<blockquote><pre>Restoring zone: user.com.db\n</pre></blockquote><br />Adding missing subdomain DNS entries (if needed)<pre></pre><br />Update Proxy subomains<blockquote><pre>Adding proxy subdomains for domain example.com.Records Installed</pre></blockquote>Done<br />\n<br />Updating SPF Records<blockquote><pre></pre></blockquote>Done<br />\n<br />Restoring quota<blockquote><pre></pre></blockquote>Done<br />\n<br /><br />Update mail routing<blockquote><pre>LOCAL MAIL EXCHANGER: This server will serve as a primary mail exchanger for example.com's mail.: This configuration has been manually selected.\n</pre></blockquote>Done<br />\n<br />Rebuilding Apache Conf<br />Restore CompleteAccount Restore Complete\nUnlocking password for user user.passwd: Success.<br />","type":"string"}}},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Restore account backup","tags":["Account Restoration","Restore Account"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restoreaccount \\\n user='username' \\\n type='monthly'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restoreaccount?api.version=1&user=username&type=monthly"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.28"}},"/start_background_pkgacct":{"get":{"description":"This function backs up an account with [the pkgacct script](https://go.cpanel.net/pkgacctscript).\n\n**Note:**\n\n- The `/usr/local/cpanel/scripts/pkgacct` script logs results to the `/var/cpanel/pkgacct_sessions/session_id/` directory, where `session_id` represents the backup session's ID.\n- The target system streams the output of this function with the `/usr/local/cpanel/whostmgr/docroot/cgi/live_tail_log.cgi` script on the source system. Users should **not** directly call this script.","operationId":"start_background_pkgacct","parameters":[{"description":"The cPanel account to back up.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"Whether to compress the data in .gzip format.\n* `compress` - Compress the data.\n* `null` - Do **not** compress the data.","in":"query","name":"compressionsetting","required":false,"schema":{"default":null,"enum":["compress"],"example":"compress","nullable":true,"type":"string"}},{"description":"Whether to update the destination file with any new content since the previous backup.\nThis parameter also removes any content that no longer exists on the account.\nIf the destination file does **not** exist, the function creates a new file in that location.\n* `1` — Create an incremental archive file.\n* `0` — Do **not** create an incremental archive file.\n\n**Note:**\n\n When you use this parameter, the system creates the backup as an uncompressed archive.","in":"query","name":"incremental","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to run the background task with a reduced priority.\n* `1` — Run the backup as a low priority task.\n* `0` — Run the backup with normal priority.","in":"query","name":"low_priority","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The minimum version of MySQL® that the system requires to restore the backed up database files.\n\n**Note:**\n\n- You can view the server's installed version of MySQL in the `/var/cpanel/cpanel.config` file.\n- This parameter defaults to the current installed version of MySQL.","in":"query","name":"mysqlver","required":false,"schema":{"example":"5.5","type":"string"}},{"description":"Whether to encode each line of the script's output in JSON format in order to allow the `live_tail_log.cgi` script to stream it.\n* `1` — Serialize the output.\n* `0` — Do **not** serialize the output.","in":"query","name":"serialized_output","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to exclude the account's databases from the cpmove archive.\n* `1` — Do **not** back up the account's databases.\n* `0` — Back up the account's databases.","in":"query","name":"skipacctdb","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to exclude the account's API tokens from the archive.\n* `1` — Do **not** back up the account's API tokens.\n* `0` — Back up the account's API tokens.","in":"query","name":"skipapitokens","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to exclude the account's external authentication credentials from the archive.\n* `1` — Do **not** back up the account's external authentication credentials.\n* `0` — Back up the account's external authentication credentials.","in":"query","name":"skipauthnlinks","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to exclude the account's bandwidth data from the archive.\n* `1` — Do **not** back up the account's bandwidth data.\n* `0` — Back up the account's data.","in":"query","name":"skipbwdata","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to exclude the account's DNSSEC configuration from the archive.\n* `1` — Do **not** back up the account's DNSSEC configuration.\n* `0` — Back up the account's DNSSEC configuration.","in":"query","name":"skipdnssec","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to exclude the account's DNS zone file information from the archive.\n* `1` — Do **not** back up the account's DNS zone file information.\n* `0` — Back up the account's DNS zone file information.","in":"query","name":"skipdnszones","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to exclude the account's FTP user accounts from the archive.\n* `1` — Do **not** back up the account's FTP user accounts.\n* `0` — Back up the account's FTP user accounts.","in":"query","name":"skipftpusers","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to skip the home directory's contents.\n* `1` — Do **not** back up the account's home directory.\n* `0` — Back up the account's home directory.","in":"query","name":"skiphomedir","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to exclude the account's cPanel & WHM linked server nodes configuration from the archive.\n* `1` — Do **not** back up the account's linked server nodes configuration.\n* `0` — Back up the account's linked server nodes configuration.","in":"query","name":"skiplinkednodes","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to exclude the account's log files from the archive.\n* `1` — Do **not** back up the account's log files.\n* `0` — Back up the account's log files.","in":"query","name":"skiplogs","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to exclude the account's reseller privileges from the archive.\n* `1` — Do **not** back up the account's reseller privileges.\n* `0` — Back up the account's reseller privileges.","in":"query","name":"skipresellerconfig","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to exclude the account's shell information and privileges from the archive.\n* `1` — Do **not** back up the account's shell information and privileges.\n* `0` — Back up the account's shell information and privileges.","in":"query","name":"skipshell","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to exclude the account's virtual host (vhost) templates from the archive.\n* `1` — Do **not** back up the account's vhost templates.\n* `0` — Back up the account's vhost templates.","in":"query","name":"skipvhosttemplates","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to create the cpmove archive in chunks.\n* `1` — Create the archive in chunks.\n* `0` — Create a single archive file.","in":"query","name":"split","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The path to the directory in which you wish to store the cpmove archive.\n\n**Note:**\n\nThis parameter defaults to `/home/user`, where `user` represents the username of the account.","in":"query","name":"tarroot","required":false,"schema":{"example":"/home/user","type":"string"}},{"description":"Whether to use the account's last known successful backup as a template when the script creates the cpmove archive, if any exist.\n* `1` — Use the account's last known successful backup as a template, if any exist.\n* `0` — Do **not** use the account's last known successful backup.\n\n**Note:**\n\n This parameter may reduce the amount of time that the backup process requires.","in":"query","name":"use_backups","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"complete_master_error_log":{"description":"The name of the master error log.\n\n**Note:**\n\n The target system streams the output of this file with the `live_tail_log.cgi` script; however, users should **not** directly call this script.","example":"master.error_log","type":"string"},"complete_master_log":{"description":"The name of the master log.\n\n**Note:**\n\n The target system streams the output of this file with the `live_tail_log.cgi` script; however, users should **not** directly call this script.","example":"master.log","type":"string"},"session_id":{"description":"The backup's session ID.","example":"example20151109162046c4xzDp55q9u4tPj","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"start_background_pkgacct","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Back up an account using the pkgacct script","tags":["Backups","Backup or Restore"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n start_background_pkgacct \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/start_background_pkgacct?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/restore_queue_list_pending":{"get":{"description":"This function lists the tasks that the restoration queue has not yet processed.","operationId":"restore_queue_list_pending","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"restore_job":{"description":"An array of objects that contain information about a pending task in the restoration queue.","items":{"properties":{"options":{"description":"A list of information about the options for a pending task in the restoration queue.","properties":{"destid":{"description":"The destination's identification string.\n\n* `local` — The local directory.\n* The destination ID string's value.","example":"LmTZCUpqqLSPH8AO7pVtIeNK","type":"string"},"give_ip":{"description":"Whether the task will assign the account a dedicated IP address.\n\n* `1` — Assign.\n* `0` — Will **not** assign.","enum":[0,1],"example":1,"type":"integer"},"mail_config":{"description":"Whether the function will restore the account's email configuration.\n\n* `1` — Restore.\n* `0` — Will **not** restore.","enum":[0,1],"example":1,"type":"integer"},"mysql":{"description":"Whether the task will restore the account's MySQL® databases.\n\n* `1` — Restore.\n* `0` — Will **not** restore.","enum":[0,1],"example":1,"type":"integer"},"subdomains":{"description":"Whether the function will restore the account's subdomains.\n\n* `1` — Restore.\n* `0` — Will **not** restore.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"restore_point":{"description":"The date of the backup that the task will use, in `YYYY-MM-DD` format.","example":"2015-10-21T00:00:00.000Z","format":"ISO-8601 Date","type":"string"},"user":{"description":"The cPanel account's username.","example":"username","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_queue_list_pending","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return pending restoration tasks list","tags":["Account Restoration","Restore Queue Reporting"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restore_queue_list_pending\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_list_pending?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/toggle_user_backup_state":{"get":{"description":"This function enables or disables legacy backups for a user.","operationId":"toggle_user_backup_state","parameters":[{"description":"The cPanel account's username.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"Whether the account should use the legacy backup system.\n* `1` - Use the legacy backup system.\n* `0` - Use the standard backup system.","in":"query","name":"legacy","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"toggle_status":{"description":"Whether backups are active on the account.\n* `1` - Active.\n* `0` - Inactive.","enum":[0,1],"example":0,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"toggle_user_backup_state","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result`\nfield is `0`. This field may display a success message when\na function succeeds.","example":"Backup state modified","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable or disable legacy backups","tags":["Backups","Backup Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n toggle_user_backup_state \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/toggle_user_backup_state?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/limitbw":{"get":{"description":"This function modifies a cPanel account's bandwidth quota.","operationId":"limitbw","parameters":[{"description":"The username of a cPanel account on the server.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}},{"description":"The account's new bandwidth quota, in megabytes (MB).\n* `0` and `unlimited` - Grant the user unlimited bandwidth","in":"query","name":"bwlimit","required":false,"schema":{"default":"unlimited","example":0,"oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":0,"type":"integer"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"bwlimits":{"description":"An array of objects containing account information.","items":{"properties":{"bwlimit":{"description":"The account's new bandwidth quota, in megabytes (MB).\n* `0` - The user has unlimited bandwidth.","example":0,"minimum":0,"type":"integer"},"bwlimitenable":{"description":"Whether bandwidth limiting is enabled for the account.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[0,1],"example":0,"type":"integer"},"domains":{"description":"An array of all of the cPanel account's domains.","example":["example.com","addondomain.com","subdomain.example.com"],"items":{"type":"string"},"type":"array"},"human_bwlimit":{"description":"The account's bandwidth quota, in human-readable format.\n* `unlimited` - The user has unlimited bandwidth.\n* A positive integer that represents a maximum monthly bandwidth use, a space, and the string MB.","example":"500 MB","pattern":"^(unlimited|\\d+ MB)$","type":"string"},"human_bwused":{"description":"The account's current bandwidth usage, in human-readable format.\n* `none`\n* A positive integer that represents the amount of bandwidth used, a space, and the string MB.","example":"none","pattern":"^(none|\\d+ MB)$","type":"string"},"unlimited":{"description":"Whether the account's bandwidth quota is unlimited.\n* `1` - Unlimited.\n* `0` - Not unlimited.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"limitbw","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Bandwidth Limit for username has been set to unlimited megabytes","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update cPanel account bandwidth quota","tags":["Bandwidth and Disk Quotas"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n limitbw \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/limitbw?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/cors_proxy_get":{"get":{"description":"This function allows your system to perform Cross-Origin Resource Sharing (CORS) HTTP requests.","operationId":"cors_proxy_get","parameters":[{"description":"The website that you wish to access.","in":"query","name":"url","required":true,"schema":{"example":"http://www.example.com","format":"url","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"_cp_redirects":{"description":"An array that contains the redirects which the website performs, if any exist.\n\n**Notes:**\n\n* This return counts redirects.\n* If any redirects exist, this returns as an array of objects containing the `content`, `protocol`, `reason`, `status`, `success`, and `url` returns and the `headers` object.\n* `null` - Redirects do not exist.\n\n**Note:**\n\n The JSON example output above displays this condition.","items":{"properties":{"headers":{"additionalProperties":{"oneOf":[{"type":"string"},{"type":"integer"}],"x-additionalPropertiesName":"header-name"},"description":"An object containing the header fields that the request returned.\n\n**Note:**\n\nThis object's keys vary based on the URL's headers.","example":{"age":"425879","cache-control":"max-age=604800","content-length":"1256","content-type":"text/html; charset=UTF-8","date":"Thu, 05 Mar 2020 23:42:25 GMT","etag":"\"3147526947+ident\"","expires":"Thu, 12 Mar 2020 23:42:25 GMT","last-modified":"Thu, 17 Oct 2019 07:18:26 GMT","server":"ECS (dab/4BA8)","vary":"Accept-Encoding","x-cache":"HIT"},"nullable":true,"type":"object"},"protocol":{"description":"The URL's HTTP protocol.","example":"HTTP/1.1","nullable":true,"type":"string"},"reason":{"description":"The response that the server returned.","example":"OK","nullable":true,"type":"string"},"status":{"description":"The response's HTTP status code.","example":"200","nullable":true,"type":"string"},"success":{"description":"Whether the function returned a 2XX HTTP status code.\n- `1` - Success.\n- `0` - Failure.","enum":[0,1],"example":1,"nullable":true,"type":"integer"},"url":{"description":"The URL that provided the response.","example":"http://www.example.com","format":"url","nullable":true,"type":"string"}},"type":"object"},"nullable":true,"type":"array"},"content":{"description":"The URL's content.\n\n**Note:**\n\n We strongly recommend that you confirm the content's type before you use the content return's value. The function may also return this value in the _cp_redirects array of hashes. A valid string.","example":"<!doctype html>\\n<html>\\n<head>\\n <title>Example Domain</title>\\n\\n <meta charset=\\\"utf-8\\\" />\\n <meta http-equiv=\\\"Content-type\\\" content=\\\"text/html; charset=utf-8\\\" />\\n <meta name=\\\"viewport\\\" content=\\\"width=device-width, initial-scale=1\\\" />\\n <style type=\\\"text/css\\\">\\n body {\\n background-color: #f0f0f2;\\n margin: 0;\\n padding: 0;\\n font-family: -apple-system, system-ui, BlinkMacSystemFont, \\\"Segoe UI\\\", \\\"Open Sans\\\", \\\"Helvetica Neue\\\", Helvetica, Arial, sans-serif;\\n\\n }\\n div {\\n width: 600px;\\n margin: 5em auto;\\n padding: 2em;\\n background-color: #fdfdff;\\n border-radius: 0.5em;\\n box-shadow: 2px 3px 7px 2px rgba(0,0,0,0.02);\\n }\\n a:link, a:visited {\\n color: #38488f;\\n text-decoration: none;\\n }\\n @media (max-width: 700px) {\\n div {\\n margin: 0 auto;\\n width: auto;\\n }\\n }\\n </style>\\n</head>\\n\\n<body>\\n<div>\\n <h1>Example Domain</h1>\\n <p>This domain is for use in illustrative examples in documents. You may use this\\n domain in literature without prior coordination or asking for permission.</p>\\n <p><a href=\\\"https://www.iana.org/domains/example\\\">More information...</a></p>\\n</div>\\n</body>\\n</html>\\n","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"cors_proxy_get","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable CORS HTTP requests","tags":["API Execution"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n cors_proxy_get \\\n url='http://www.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/cors_proxy_get?api.version=1&url=http%3a%2f%2fwww.example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"68","x-cpanel-internal-only":false}},"/delete_configclusterserver":{"get":{"description":"This function removes a server from a configuration cluster. The function's return\ndata appears in the `metadata` section of its output.\n\n**Important:**\n\nIf you log in to a configuration cluster server that is **not** the parent server,\n**nothing** will indicate that the server is part of a configuration cluster. You can\n**only** view and modify this information from the parent server.","operationId":"delete_configclusterserver","parameters":[{"description":"The hostname or IP address of a remote configuration cluster server.","in":"query","name":"name","required":true,"schema":{"example":"example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"delete_configclusterserver","type":"string"},"name":{"description":"The remote configuration cluster server's name.","example":"example.com","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete server from configuration cluster","tags":["Server Administration","Configuration Clusters"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n delete_configclusterserver \\\n name='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_configclusterserver?api.version=1&name=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.44"}},"/add_configclusterserver":{"post":{"description":"This function adds a server to a configuration cluster. The function's return data appears in\nthe `metadata` section of its output.\n\nWe recommend that you run this function as a `POST` request with SSL enabled:\n\n* The length of the remote access key may cause problems if you run the function with the `GET`\nmethod (for example, a URL in your browser).\n* You risk security problems if you enter a remote access key through the `GET` method.\n\n**Important:**\n\n* Run this function as a `root`-level user on the server that you wish to use as the parent server.\n* If you log in to a configuration cluster server that is **not** the parent server, **nothing**\nwill indicate that the server is part of a configuration cluster. You can **only** view and modify\nthis information from the parent server.","operationId":"add_configclusterserver","parameters":[{"description":"The remote configuration cluster server's name.","in":"query","name":"name","required":true,"schema":{"example":"example.com","type":"string"}},{"description":"The username for the server's `root`-level account.","in":"query","name":"user","required":true,"schema":{"example":"root","type":"string"}},{"description":"A truncated version of the server's remote access key.","in":"query","name":"key","required":true,"schema":{"example":"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"add_configclusterserver","type":"string"},"name":{"description":"The remote configuration cluster server's name.","example":"example.com","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"signature":{"description":"A truncated version of the server's remote access key.","example":"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0","type":"string"},"user":{"description":"The username for the server's `root`-level account.","example":"root","type":"string"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add configuration cluster server","tags":["Server Administration","Configuration Clusters"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n add_configclusterserver \\\n name='example.com' \\\n user='root' \\\n key='d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/add_configclusterserver?api.version=1&name=example.com&user=root&key=d0%3ad0%3ad0%3ad0%3ad0%3ad0%3ad0%3ad0%3ad0%3ad0%3ad0%3ad0%3ad0%3ad0%3ad0%3ad0"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.44"}},"/list_configclusterservers":{"get":{"description":"This function lists the servers in the server's configuration cluster.\n\n**Warning**:\n\n* WHM's Remote Access Key feature is deprecated. We **strongly** recommend that you use API tokens instead.\n\n* If you log in to a configuration cluster server that is **not** the parent server, **nothing** will indicate that the server is part of a configuration cluster. You can only view and modify this information from the parent server.","operationId":"list_configclusterservers","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"additionalProperties":{"description":"Each return's name is the server name.","properties":{"signature":{"description":"A truncated version of the server's remote access key.","type":"string"},"user":{"description":"The `root`-level username for the server.","type":"string"}},"type":"object"},"description":"Configuration cluster signatures and users for each server.","example":{"example1.com":{"signature":"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0","user":"root"},"example2.com":{"signature":"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d1","user":"root"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_configclusterservers","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all configuration cluster servers","tags":["Server Administration","Configuration Clusters"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_configclusterservers\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_configclusterservers?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.44"}},"/update_configclusterserver":{"get":{"description":"This function updates the username or remote access key for a cluster server.\n\n**Important:**\n\n* If you log in to a configuration cluster server that is *not* the parent server, *nothing* will indicate that the server is part of a configuration cluster. You can *only* view and modify this information from the master server.\n\n* We recommend that you run this function as a `POST` request with SSL enabled:\n * The length of the remote access key may cause problems if you run the function with the `GET` method (for example, a URL in your browser).\n * You risk security problems if you enter a remote access key through the `GET` method.","operationId":"update_configclusterserver","parameters":[{"description":"The remote configuration cluster server's name or IP address.","in":"query","name":"name","required":true,"schema":{"example":"example.com","type":"string"}},{"description":"The server's `root`-level account username. If you do not specify a value, the function does not update the username.","in":"query","name":"user","required":false,"schema":{"example":"root","type":"string"}},{"description":"The new [remote access key](https://docs.cpanel.net/whm/clusters/remote-access-key/). If you do **not** specify a value, the function does not update the remote access key.","in":"query","name":"key","required":false,"schema":{"example":"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"update_configclusterserver","type":"string"},"name":{"description":"The remote configureation cluster server's name.","example":"example.com","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"signature":{"description":"The new remote access key.","example":"d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0","type":"string"},"user":{"description":"The server's `root`-level account username.","example":"root","type":"string"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update configuration cluster server credentials","tags":["Server Administration","Configuration Clusters"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n update_configclusterserver \\\n name='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/update_configclusterserver?api.version=1&name=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.44"}},"/validate_current_dmarcs":{"get":{"description":"This function retrieves and checks the 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\nTo check multiple domains, duplicate or increment the parameter name.\nFor example, `domain-1`, `domain-2`, and `domain-3` parameters.\n\nIf you do not include this argument, the system will validate DMARC records for all domains on the server.","examples":{"multiple":{"summary":"Check the DMARC record for multiple domains.","value":"domain-1=example.com&domain-2=example.com&domain-3=example3.com"},"multiple-alternative":{"summary":"Check the DMARC record for multiple domains.","value":"domain=example.com&domain=example2.com&domain=example3.com"},"single":{"summary":"Check the DMARC records for a single domain.","value":"domain=example.com"}},"in":"query","name":"domain","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects containing information about the domain's DMARC records.","example":[{"domain":"example.com","error":"","record":"v=DMARC1; p=none;","state":"VALID","subdomain":"_dmarc.example.com","suggested":"v=DMARC1; p=none;"},{"domain":"example2.com","error":"(XID 4krw35) DNS returned “SERVFAIL” (code 2) in response to the system’s query for “_dmarc.example2.com”’s “TXT” records.","record":"","state":"DNS_ERROR","subdomain":"_dmarc.example2.com","suggested":"v=DMARC1; p=none;"}],"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.","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 policy 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":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"validate_current_dmarcs","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate DMARC records","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n validate_current_dmarcs \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/validate_current_dmarcs?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"124"}},"/twofactorauth_get_tfa_config_for_user":{"get":{"description":"This function returns the Two-Factor Authentication (2FA) configuration for a cPanel account, its email accounts, and its team user accounts.","operationId":"twofactorauth_get_tfa_config_for_user","parameters":[{"description":"The username for the account.","in":"query","name":"user","required":true,"schema":{"example":"example","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"additionalProperties":{"properties":{"email":{"additionalProperties":{"description":"An object that contains a hash of the email account's data.","properties":{"secret":{"description":"The 2FA secret for the account.","example":"QLLIU5WTY3UTJGNG","type":"string"}},"type":"object"},"description":"The email data for the user.","type":"object"},"primary_account":{"description":"An object containing the secret for the cPanel user if 2FA is enabled for the user.","properties":{"secret":{"description":"The 2FA secret for the account.","type":"string"}},"type":"object"},"team":{"additionalProperties":{"description":"An objection that contains a hash of the team user account's data.","properties":{"secret":{"description":"The 2FA secret for the account.","example":"QLLIU5WTY3UTJGNG","type":"string"}},"type":"object"},"description":"The cPanel user's team user account data.","type":"object"}},"type":"object"},"description":"The cPanel user account that the API was called for.","example":{"example":{"email":{"user@example.com":{"secret":"QLLIU5WTY3UTJGNG"}},"primary_account":{"secret":"QLLIU5WTY3UTJGNG"},"team":{"team_user@example":{"secret":"QLLIU5WTY3UTJGNG"}}}}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"twofactorauth_get_tfa_config_for_user","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account 2FA data","tags":["Authentication","Two-Factor Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n twofactorauth_get_tfa_config_for_user \\\n user='user'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/twofactorauth_get_tfa_config_for_user?api.version=1&user=user"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"118"}},"/is_role_enabled":{"get":{"description":"This function checks whether a specific server role is currently enabled\nfor the server.\n\nFor more information about server roles, read our [How to Use Server Profiles](https://go.cpanel.net/serverroles) documentation.","operationId":"is_role_enabled","parameters":[{"description":"The role to check. The role must be one of the following case-sensitive values:\n\n* `CalendarContact` - Allows users to access CalDAV and CardDAV services and features.\n* `DNS` - Allows users to create and edit Domain Name System (DNS) zone files. This role doesn’t convert your server to a cPanel DNSOnly™ server.\n* `FileStorage` - Allows users to access cPanel’s [File Manager](https://go.cpanel.net/cpaneldocsFileManager) and [Git™ Version Control](https://go.cpanel.net/cpaneldocsasisGitVersionControl) features. When a profile disables this role, you can’t enable the Shell Access setting when you create a new cPanel account.\n\n* `FTP` - Allows users to manage their account’s files with an FTP client.\n* `MailLocal` - Allows the control of local mail delivery and related features.\n* `MailReceive` - Allows users to receive mail from external sources.\n* `MailRelay` - Allows the server’s Message Transfer Agent (MTA) to forward mail from one remote host to another.\n* `MailSend` - Allows users to send mail and control the features necessary for sending mail.\n* `MySQL` - Allows users to create and manage MySQL® or MariaDB databases.\n* `MySQLClient` - This role checks whether the MySQL/MariaDB client access exists locally or remotely. You cannot directly enable or disable this role. The system enables or disables this role depending on the MySQL configuration.\n\n* `Postgres` - Allows users to create and manage [PostgreSQL](https://go.cpanel.net/whmdocsConfigurePostgreSQL) databases if cPanel & WHM manages the server’s PostgreSQL.\n* `PostgresClient` - This role checks whether the PostgreSQL client access exists locally.\n* `SpamFilter` - Allows users to use Apache SpamAssassin™ to identify, sort, and delete unsolicited mail.\n* `WebDisk` - Allows users to manage their account’s files with a WebDAV client.\n* `Webmail` - Allows users to access webmail services and features.\n* `WebServer` - Allows users to create and manage websites for their domains.","in":"query","name":"role","required":true,"schema":{"enum":["CalendarContact","DNS","FileStorage","FTP","MailLocal","MailReceive","MailRelay","MailSend","MySQL","MySQLClient","Postgres","PostgresClient","SpamFilter","WebDisk","Webmail","WebServer"],"example":"FTP","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"enabled":{"description":"Whether a role is enabled or disabled.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"is_role_enabled","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether server role is enabled","tags":["Server Administration","Server Profiles"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n is_role_enabled \\\n role='FTP'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/is_role_enabled?api.version=1&role=FTP"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"76"}},"/get_all_contact_importances":{"get":{"description":"This function lists the importance of all application events in\nWHM's\n[*Contact Manager*](https://docs.cpanel.net/whm/server-contacts/contact-manager/)\ninterface (*WHM >> Home >> Server Contacts >> Contact Manager*).","operationId":"get_all_contact_importances","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"importances":{"description":"An array of objects containing event importance information.","items":{"properties":{"app":{"description":"The cPanel & WHM module's name.","example":"wwwacct","type":"string"},"event":{"description":"The event's name.\n\n**Note:**\n\nAn asterisk character (`*`) represents all events in the module.","example":"*","type":"string"},"importance":{"description":"The importance of the contact event:\n\n* `1` — High.\n* `2` — Medium.\n* `3` — Low.\n* `0` — Disabled.","example":0,"type":"integer"},"name":{"description":"The contact event's name:\n\n* `High`\n* `Medium`\n* `Low`\n* `Disabled`","example":"High","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_all_contact_importances","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Contact Manager event importance settings","tags":["Server Administration","Notifications"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_all_contact_importances\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_all_contact_importances?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/twofactorauth_set_tfa_config_for_user":{"post":{"description":"This function updates the Two-Factor Authentication (2FA) configuration for the given cPanel user.","operationId":"twofactorauth_set_tfa_config_for_user","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":{"description":"The cPanel user account for which to set the 2FA config.","properties":{"email":{"additionalProperties":{"description":"An object that contains a hash of the email account's data.","properties":{"secret":{"description":"The 2FA secret for the account.","example":"QLLIU5WTY3UTJGNG","type":"string"}},"type":"object"},"description":"The email data for the user.","type":"object"},"primary_account":{"description":"An object that contains the secret for the cPanel user.","properties":{"secret":{"description":"The 2FA secret for the account.","example":"QLLIU5WTY3UTJGNG","type":"string"}},"type":"object"},"team":{"additionalProperties":{"description":"An object that contains a hash of the team user account's data.","properties":{"secret":{"description":"The 2FA secret for the account.","example":"QLLIU5WTY3UTJGNG","type":"string"}},"type":"object"}}},"type":"object"},"example":{"example":{"email":{"user@example.com":{"secret":"QLLIU5WTY3UTJGNG"}},"primary_account":{"secret":"QLLIU5WTY3UTJGNG"},"team":{"team_user@example":{"secret":"QLLIU5WTY3UTJGNG"}}}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"twofactorauth_set_tfa_config_for_user","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update cPanel account's 2FA data","tags":["Authentication","Two-Factor Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"echo '{\"example\" : { \"email\" : { \"user@example.com\" : { \"secret\" : \"QLLIU5WTY3UTJGNG\" } }, \"primary_account\" : { \"secret\" : \"QLLIU5WTY3UTJGNG\" }, \"team\" : { \"team_user@example\" : { \"secret\" : \"QLLIU5WTY3UTJGNG\" }}}}' | \\\nwhmapi1 --input=json --output=jsonpretty \\\n twofactorauth_set_tfa_config_for_user\n"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/json-api/twofactorauth_set_tfa_config_for_user HTTP/1.1\nHost: example.com:2087\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 179\n\n{\"example\":{\"email\":{\"user@example.com\":{\"secret\":\"QLLIU5WTY3UTJGNG\"}},\"primary_account\":{\"secret\":\"QLLIU5WTY3UTJGNG\"},\"team\":{\"team_user@example\":{\"secret\":\"QLLIU5WTY3UTJGNG\"}}}}"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"118"}},"/leika_get_config":{"get":{"description":"This function retrieves configuration data using `Cpanel::Leika::get_config()`.\nIf no `item` parameters are 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.","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":{"content":{"application/json":{"schema":{"properties":{"data":{"description":"A hash of configuration keys and their values.","additionalProperties":{"type":"string"},"example":{"cpanel.key1":"enabled","webmail.key3":{"subkey1":"active","subkey2":"inactive"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"leika_get_config","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Retrieve Leika configuration","tags":["Leika","Configuration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n leika_get_config item=key1 item=key2\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/leika_get_config?api.version=1&item=key1&item=key2"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"132"}},"/get_application_contact_importance":{"get":{"description":"This function retrieves the importance level of an application's events for WHM's\n[*Contact Manager*](https://docs.cpanel.net/whm/server-contacts/contact-manager/)\ninterface (*WHM >> Home >> Server Contacts >> Contact Manager*).\n\n**Note:**\n\nThe system creates a notification setting for the application's events if one does\nnot already exist.","operationId":"get_application_contact_importance","parameters":[{"description":"The cPanel & WHM application module's name.","in":"query","name":"app","required":true,"schema":{"example":"Check","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"importance":{"description":"The importance level at which to send the notification.\n* `1` — High.\n* `2` — Medium.\n* `3` — Low.\n* `0` — Disabled.","enum":[1,2,3,0],"example":0,"type":"integer"},"name":{"description":"The text version of the importance setting.\n* `High`\n* `Medium`\n* `Low`\n* `Disabled`","enum":["High","Medium","Low","Disabled"],"example":"Disabled","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_application_contact_importance","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return app contact importance setting","tags":["Server Administration","Notifications"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_application_contact_importance \\\n app='Check'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_application_contact_importance?api.version=1&app=Check"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/get_application_contact_event_importance":{"get":{"description":"This function retrieves the importance level of an application event for WHM's Contact Manager interface (Home >> Server Contacts >> Contact Manager).\n\n**Note:**\n\n The system will create a notification setting for the application's events if one does not already exist.","operationId":"get_application_contact_event_importance","parameters":[{"description":"The application module's name.","in":"query","name":"app","required":true,"schema":{"example":"Check","type":"string"}},{"description":"The event's name.","in":"query","name":"event","required":true,"schema":{"example":"SecurityAdvisorStateChange","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"importance":{"description":"The importance level at which to send the notification.\n* `1` - High.\n* `2` - Medium.\n* `3` - Low.\n* `0` - Disabled.","enum":[1,2,3,0],"example":0,"type":"integer"},"name":{"description":"The text version of the importance.\n- `High`\n- `Medium`\n- `Low`\n- `Disabled`","enum":["High","Medium","Low","Disabled"],"example":"Disabled","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_application_contact_event_importance","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return app's event contact importance setting","tags":["Server Administration","Notifications"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_application_contact_event_importance \\\n app='Check' \\\n event='SecurityAdvisorStateChange'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_application_contact_event_importance?api.version=1&app=Check&event=SecurityAdvisorStateChange"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/set_application_contact_event_importance":{"get":{"description":"This function sets the importance level of an application event for WHM's\n[*Contact Manager*](https://go.cpanel.net/whmdocsContactManager)\ninterface (*WHM >> Home >> Server Contacts >> Contact Manager*).\n\nFor a list of available modules, use the WHM API 1\n[`get_all_contact_importances`](/openapi/whm/operation/get_all_contact_importances/)\nfunction.\n\n**Note:**\n\nThe system creates a notification setting for the application's events\nif one does not already exist.","operationId":"set_application_contact_event_importance","parameters":[{"description":"The cPanel & WHM application module's name.","in":"query","name":"app","required":true,"schema":{"example":"Check","type":"string"}},{"description":"The event's name.","in":"query","name":"event","required":true,"schema":{"example":"SecurityAdvisorStateChange","type":"string"}},{"description":"The importance level at which to send the notification.\n\n* `High`\n* `Medium`\n* `Low`\n* `Disabled`","in":"query","name":"importance","required":true,"schema":{"enum":["High","Medium","Low","Disabled"],"example":"Disabled","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_application_contact_event_importance","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update app's event contact importance setting","tags":["Server Administration","Notifications"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_application_contact_event_importance \\\n app='Check' \\\n event='SecurityAdvisorStateChange' \\\n importance='Disabled'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_application_contact_event_importance?api.version=1&app=Check&event=SecurityAdvisorStateChange&importance=Disabled"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/set_application_contact_importance":{"get":{"description":"This function sets the importance level of an application's events for WHM's\n[*Contact Manager*](https://go.cpanel.net/whmdocsContactManager)\ninterface (*WHM >> Home >> Server Contacts >> Contact Manager*).\n\nFor a list of available modules, use the WHM API 1\n[`get_all_contact_importances`](/openapi/whm/operation/get_all_contact_importances/)\nfunction.\n\n**Note:**\n\nThe system creates a notification setting for the application's events if one\ndoes not already exist.","operationId":"set_application_contact_importance","parameters":[{"description":"The cPanel & WHM application module's name.","in":"query","name":"app","required":true,"schema":{"example":"Check","type":"string"}},{"description":"The importance level at which to send the notification.\n\n* `High`\n* `Medium`\n* `Low`\n* `Disabled`","in":"query","name":"importance","required":true,"schema":{"enum":["High","Medium","Low","Disabled"],"example":"Disabled","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_application_contact_importance","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update app contact importance setting","tags":["Server Administration","Notifications"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_application_contact_importance \\\n app='Check' \\\n importance='Disabled'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_application_contact_importance?api.version=1&app=Check&importance=Disabled"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/convert_addon_fetch_conversion_details":{"get":{"description":"This function returns the details of a conversion from an addon\ndomain to an account. Use WHM API 1's `convert_addon_domain_to_account`\nto start a conversion.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://go.cpanel.net/howtouseserverprofiles),\nthe system **disables** this function.","operationId":"convert_addon_fetch_conversion_details","parameters":[{"description":"The conversion's job identification number.","in":"query","name":"job_id","required":true,"schema":{"example":2,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"domain":{"description":"The addon domain you converted into a cPanel account.","example":"cptestaddon175.tld","format":"domain","type":"string"},"job_end_time":{"description":"A date that indicates when the convertion ended.","example":1462216653,"format":"unix_timestamp","type":"integer"},"job_id":{"description":"The conversion's job identification number.","example":2,"minimum":1,"type":"integer"},"job_start_time":{"description":"A date that indicates when the conversion started.","example":1462465001,"format":"unix_timestamp","type":"integer"},"job_status":{"description":"The status of the conversion process.\n\n* `INPROGRESS` — The conversion process is in progress.\n* `QUEUED` — The system queued the conversion job.\n* `SKIPPED` — The system skipped at least one step in the conversion process.\n* `FAILED` — At least one step in the conversion process failed.\n* `DONE` — The conversion process finished successfully.","enum":["INPROGRESS","QUEUED","SKIPPED","FAILED","DONE"],"example":"DONE","type":"string"},"source_acct":{"description":"The source cPanel user account that you converted into an account.","example":"cptest","format":"username","type":"string"},"steps":{"description":"An array of objects containing the steps taken by the conversion process.","example":[{"end_time":1462465001,"start_time":1462465001,"status":"DONE","step_name":"Saving email forwarder data","warnings":""},{"end_time":1462465001,"start_time":1462465001,"status":"DONE","step_name":"Saving custom DNS records","warnings":""},{"end_time":1462465001,"start_time":1462465001,"status":"DONE","step_name":"Saving installed SSL Certificate","warnings":""},{"end_time":1462465001,"start_time":1462465001,"status":"DONE","step_name":"Saving EasyApache 4 configuration","warnings":""},{"end_time":1462465009,"start_time":1462465001,"status":"DONE","step_name":"Removing Addon Domain","warnings":""},{"end_time":1462465014,"start_time":1462465009,"status":"DONE","step_name":"Creating new cPanel account","warnings":""},{"end_time":1462465015,"start_time":1462465014,"status":"DONE","step_name":"Restoring custom DNS records","warnings":""},{"end_time":1462465016,"start_time":1462465015,"status":"DONE","step_name":"Copying Custom VirtualHost Includes","warnings":""},{"end_time":1462465016,"start_time":1462465016,"status":"DONE","step_name":"Copying document root content","warnings":"/usr/bin/gtar: ./shadow: Cannot open: Permission denied\\n/usr/bin/gtar: Exiting with failure status due to previous errors"},{"end_time":1462465016,"start_time":1462465016,"status":"DONE","step_name":"Setting the proper permissions on document root","warnings":""},{"end_time":1462465017,"start_time":1462465016,"status":"DONE","step_name":"Copying email accounts","warnings":""},{"end_time":1462465017,"start_time":1462465017,"status":"DONE","step_name":"Restoring email forwarders","warnings":""},{"end_time":1462465017,"start_time":1462465017,"status":"DONE","step_name":"Copying Autoresponders","warnings":""},{"end_time":1462465017,"start_time":1462465017,"status":"DONE","step_name":"Copying webmail data","warnings":""},{"end_time":1462465017,"start_time":1462465017,"status":"DONE","step_name":"Restoring installed SSL Certificate","warnings":""},{"end_time":1462465017,"start_time":1462465017,"status":"DONE","step_name":"Restoring EasyApache 4 configuration","warnings":""}],"items":{"properties":{"end_time":{"description":"The date when the step ended.","format":"unix_timestamp","type":"integer"},"start_time":{"description":"The date when the step started.","format":"unix_timestamp","type":"integer"},"status":{"description":"The status of the conversion step.\n\n* `DONE` — The step is finished.\n* `IN PROGRESS` — The step is in progress.\n* `FAILED` — The step failed.","enum":["DONE","IN PROGRESS","FAILED"],"type":"string"},"step_name":{"description":"A step of the conversion process.","type":"string"},"warnings":{"description":"The warning message for the step that describes a potential problem, if any exist.","type":"string"}},"type":"object"},"type":"array"},"target_acct":{"description":"The destination cPanel user account for the conversion.","example":"user2","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"convert_addon_fetch_conversion_details","type":"string"},"reason":{"description":"The reason the function failed when the `metadata.result` field is `0`. This field may include a success message when the function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The API version of the function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return additional domain conversion details","tags":["Domain Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n convert_addon_fetch_conversion_details \\\n job_id='2'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_fetch_conversion_details?api.version=1&job_id=2"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/convert_addon_fetch_domain_details":{"get":{"description":"This function retrieves domain data for an addon domain.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"convert_addon_fetch_domain_details","parameters":[{"description":"The addon domain for which to retrieve details.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"docroot":{"description":"The absolute file path of the addon domain.","example":"/home/exampleparent/public_html/example.com","type":"string"},"has_dedicated_ip":{"description":"Whether the domain uses a dedicated IP address.\n\n* `1` — The domain uses a dedicated IP address.\n* `0` — The domain does **not** use a dedicated IP address.","enum":[1,0],"example":0,"type":"integer"},"has_ssl_cert_installed":{"description":"Whether an SSL certificate secures the domain.\n\n* `1` — An SSL certificate secures the domain.\n* `0` — An SSL certificate does **not** secure the domain.","enum":[1,0],"example":0,"type":"integer"},"ip":{"description":"The domain's IP address.","example":"192.0.2.0","format":"ipv4","type":"string"},"is_sni_supported":{"description":"Whether the domain supports Server Name Indication (SNI).\n\n* `1` — The domain supports SNI.\n* `0` — The domain does **not** support SNI.","enum":[1,0],"example":0,"type":"integer"},"number_of_autoresponders":{"description":"The number of the domain's autoresponders.","example":0,"minimum":0,"type":"integer"},"number_of_domain_forwarders":{"description":"The number of the domain's domain forwarders.","example":1,"minimum":0,"type":"integer"},"number_of_email_accounts":{"description":"The number of the domain's email accounts.","example":2,"minimum":0,"type":"integer"},"number_of_email_forwarders":{"description":"The number of the domain's email forwarders.","example":1,"minimum":0,"type":"integer"},"owner":{"description":"The addon domain owner's cPanel account username.","example":"username","format":"username","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"example":"convert_addon_fetch_domain_details","type":"string"},"reason":{"description":"The reason the function failed when the `metadata.result` field is `0`. This field may include a success message when the function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The API version of the function.","example":1,"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return additional domain data","tags":["Domain Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n convert_addon_fetch_domain_details \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_fetch_domain_details?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/convert_addon_get_conversion_status":{"get":{"description":"This function returns the status of the convert addon domain to\naccount process for specified conversion jobs. For data about the conversion\nstatus of all jobs, use the WHM API 1 `convert_addon_fetch_conversion_details`\nfunction.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"convert_addon_get_conversion_status","parameters":[{"description":"The conversion's job identification number.\n\n**Note:**\n\nTo list entries for multiple conversion jobs, increment the parameter name. For example: `job_id-0`, `job_id-1`, and `job_id-2`.","examples":{"multiple":{"summary":"Get the status for multiple conversion jobs.","value":"job_id-1=10&job_id-2=33&job_id-3=15"},"single":{"summary":"Get status for a single conversion job.","value":10}},"in":"query","name":"job_id","required":true,"schema":{"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"additionalProperties":{"description":"The converion job's identification number.\n\n**Note:**\n\nThe property name is the identification number of the requested job.","properties":{"job_end_time":{"description":"The time when the convert addon domain to account process ended.","format":"unix_timestamp","type":"integer"},"job_id":{"description":"The conversion's job identification number.\n\n**Note:**\n\nThe system stores this numeric value as a string.","minimum":1,"pattern":"[1-9]+","type":"string"},"job_status":{"description":"The status of the conversion process.\n\n* `DONE` — The conversion finished successfully.\n* `IN PROGRESS` — The conversion is running.\n* `FAILED` — The converion failed for some reason.","enum":["DONE","IN PROGRESS","FAILED"],"type":"string"},"source_acct":{"description":"The addon domain to convert into a cPanel account.","type":"string"}},"type":"object"},"description":"An object that contains details about the conversion job's status.","example":{"1":{"job_end_time":1462383658,"job_id":"1","job_status":"DONE","source_acct":"user1"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"convert_addon_get_conversion_status","type":"string"},"reason":{"description":"The reason the function failed when the `metadata.result` field is `0`. This field may include a success message when the function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The API version of the function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return conversion status for additional domain","tags":["Domain Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n convert_addon_get_conversion_status \\\n job_id='10'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_get_conversion_status?api.version=1&job_id=10"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/convert_addon_list_addon_domains":{"get":{"description":"This function returns a list of addon domains that belong to the current user.\n\n**Important:**\nWhen you disable the [Web Server role](https://https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"convert_addon_list_addon_domains","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"additionalProperties":{"description":"An object containing the domain's data.\n\n**Note:**\nThe domain's name is the return's name.","properties":{"docroot":{"description":"The document root for the addon domain.","example":"/home/exampleparent/public_html/example.com","type":"string"},"domain_type":{"description":"The domain's type.","example":"addon","type":"string"},"ip":{"description":"The domain's IPv4 address.","example":"192.0.2.0","format":"ipv4","type":"string"},"ipv6":{"description":"The domain's IPv6 address.","example":"2001:db8:a0b:12f0::1","format":"ipv6","type":"string"},"owner":{"description":"The domain's owner.","example":"exampleparent","format":"username","type":"string"},"reseller":{"description":"The domain's reseller.","example":"exampleparent","format":"username","type":"string"},"subdomain":{"description":"The domain's subdomain.","example":"example.exampleparent.com","format":"domain","type":"string"}}},"example":{"example.com":{"docroot":"/home/exampleparent/public_html/example.com","domain_type":"addon","ip":"192.0.2.0","owner":"root","subdomain":"example.exampleparent.com"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"convert_addon_list_addon_domains","type":"string"},"reason":{"description":"The reason the function failed when the `metadata.result` field is 0. This field may include a success message when the function succeeds.","example":"OK","type":"string"},"result":{"description":"- `1` - Success.\n- `0` - Failed. Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The API version of the function.","example":1,"type":"integer"}}}}}}},"description":"HTTP Request was successful."}},"summary":"Return current user's additional domains","tags":["Domain Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n convert_addon_list_addon_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_list_addon_domains?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/convert_addon_list_conversions":{"get":{"description":"This function returns a list of addon domains undergoing conversion\ninto cPanel accounts.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"convert_addon_list_conversions","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"conversions":{"description":"List of conversions from an addon domain to an independent cPanel account.","items":{"properties":{"domain":{"description":"The addon domain to convert into a cPanel account.","example":"example.com","format":"domain","type":"string"},"end_time":{"description":"A date in Unix time format that indicates when the process ended.","example":1462216653,"format":"unix_timestamp","type":"integer"},"job_id":{"description":"The conversion's job number.","example":1,"minimum":0,"type":"integer"},"source_acct":{"description":"The cPanel account username that owned the domain at the time of conversion.","example":"example","format":"username","type":"string"},"start_time":{"description":"A date in Unix time format that indicates when the process started.","example":1462216639,"format":"unix_timestamp","type":"integer"},"status":{"description":"The status of the conversion process.\n* `DONE` — The conversion is finished.\n* `IN PROGRESS` — The conversion is in progress.\n* `FAILED` — The conversion failed.","enum":["DONE","IN PROGRESS","FAILED"],"example":"DONE","type":"string"},"target_acct":{"description":"The destination user account for the conversion.","example":"example2","format":"username","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"convert_addon_list_conversions","type":"string"},"reason":{"description":"The reason the function failed when the `metadata.result` field is `0`. This field may include a success message when the function succeeds.","example":"OK","type":"string"},"result":{"description":"* 1 — Success.\n* 0 — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The API version of the function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return additional domains conversion queue","tags":["Domain Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n convert_addon_list_conversions\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_list_conversions?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/get_countries_with_known_ip_ranges":{"get":{"description":"This function lists the country codes available for whitelist and blacklist functions.","operationId":"get_countries_with_known_ip_ranges","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"countries":{"description":"A list of the [ISO 3166-1 alpha-2 country codes](https://www.iso.org/iso-3166-country-codes.html).\nYou can enter these codes to whitelist or blacklist a country's\nrange of IP addresses in the WHM API 1 function `set_cphulk_config_key`.","items":{"properties":{"code":{"description":"A valid [ISO 3166-1 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html).","example":"US","format":"ISO-3166-1 (alpha-2)","pattern":"^[A-Z]{2}$","type":"string"},"name":{"description":"The country's name.","example":"United States","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_countries_with_known_ip_ranges","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"- `1` — Success.\n- `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return login security country codes","tags":["cPHulk","Reporting"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_countries_with_known_ip_ranges\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_countries_with_known_ip_ranges?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"70"}},"/update_updateconf":{"post":{"description":"This function modifies a server's `/etc/cpupdate.conf` file. This file controls how the server handles software updates and upgrades.\n\n**Important:**\n\nYou **must** have the [`root` level Access Control List (ACL) privilege](https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges) to execute this function.","operationId":"update_updateconf","parameters":[{"description":"The cPanel & WHM installation's release tier, or a [valid version number](https://go.cpanel.net/longtermsupport).\n\nIf you do not use this parameter, the system retains the current setting.\n\n* A valid cPanel & WHM version number.\n* `STABLE` - This version has received considerable public exposure, testing, and verification.\n* `RELEASE` - This version is feature-complete and well-tested. It contains all intended features and functionality.\n* `CURRENT` - This version is tested and verified, but it may not contain all of the proposed functionality of a release. This tier is similar to the \"release candidate\" tier that other publication schemes use.\n* `EDGE` - This version only has rudimentary testing. The features are subject to further modification. This version usually lacks official public documentation.\n* `LTS` - Some hosting providers do not wish to upgrade cPanel & WHM to newer major versions. This is a single cPanel & WHM version for the year-long period in which WebPros International, LLC supports it.\n\n If you do not set this parameter, the system retains the current setting.\n\n New installations default to RELEASE.","in":"query","name":"CPANEL","required":false,"schema":{"anyOf":[{"enum":["STABLE","RELEASE","CURRENT","EDGE","LTS"],"type":"string"},{"format":"cPanel version","type":"string"},{"type":"string"}],"example":"RELEASE"}},{"description":"The frequency with which the server updates the operating system distribution's packages each time that the `/usr/local/cpanel/scripts/upcp` script runs.\n\nIf you do not set this parameter, the system retains the current setting.\n\n* `daily` - Update the system packages daily.\n* `manual` - Update the system packages manually.\n* `never` - If you specify `never`, the server administrator **must** run the `/usr/local/cpanel/scripts/update-packages` script when they update the server's packages.","in":"query","name":"RPMUP","required":false,"schema":{"anyOf":[{"enum":["daily","manual","never"],"type":"string"},{"type":"string"}],"example":"daily"}},{"description":"The frequency with which the server updates Apache SpamAssassin's™ rules when the `/usr/local/cpanel/scripts/upcp` script runs.\n\nIf you do not set this parameter, the system retains the current setting.\n\n* `daily` - Update Apache SpamAssassin rules daily.\n* `manual` - Update Apache SpamAssassin rules manually.\n* `never` - If you specify `never`, the server administrator **must** run the `/usr/local/cpanel/scripts/update-packages` script when they update Apache SpamAssassin's rules.","in":"query","name":"SARULESUP","required":false,"schema":{"anyOf":[{"enum":["daily","manual","never"],"type":"string"},{"type":"string"}],"example":"daily"}},{"description":"When the system will check for updates.\n\nIf you do not set this parameter, the system retains the current setting.\n\n* `daily` - Update cPanel & WHM automatically through a cron job once every 24 hours.\n* `manual` - Update cPanel & WHM manually.\n* `never` - Do **not** update cPanel & WHM.","in":"query","name":"UPDATES","required":false,"schema":{"anyOf":[{"enum":["daily","manual","never"],"type":"string"},{"type":"string"}],"example":"daily"}},{"description":"The absolute directory path to the staging directory for updates.\n\nIf you do not set this parameter, the system retains the current setting.","in":"query","name":"STAGING_DIR","required":false,"schema":{"example":"/usr/local/cpanel","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"update_updateconf","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update software update behavior","tags":["Updates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n update_updateconf\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/update_updateconf?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/get_current_profile":{"get":{"description":"This function returns details about the server's current\n[cPanel & WHM server profile](https://docs.cpanel.net/whm/server-configuration/server-profile/).","operationId":"get_current_profile","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"code":{"description":"The code ID of the current profile.","example":"MAILNODE","type":"string"},"description":{"description":"A description about the current profile.","example":"This profile provides only services and cPanel features that allow the system to serve mail.","type":"string"},"disabled_roles":{"description":"The disabled roles of the current profile.","example":[{"description":"FTP allows users to manage the files associated with their site with an FTP client.","module":"FTP","name":"FTP"},{"description":"File Storage allows users to access the File Manager and Git™ Version Control features.","module":"FileStorage","name":"File Storage"},{"description":"MySQL®/MariaDB allows users to create and manage MySQL/MariaDB databases.","module":"MySQL","name":"MySQL/MariaDB"},{"description":"PostgreSQL allows users to create and manage PostgreSQL databases.","module":"Postgres","name":"PostgreSQL"},{"description":"Web Disk allows users to manage and manipulate files on the server with multiple types of devices.","module":"WebDisk","name":"Web Disk"},{"description":"Web Server allows users to create and manage websites for their domains.","module":"WebServer","name":"Web Server"}],"items":{"properties":{"description":{"description":"The role's description.","type":"string"},"module":{"description":"The role's module name.","type":"string"},"name":{"description":"The role's name.","type":"string"}},"type":"object"},"type":"array"},"enabled_roles":{"description":"The current profile's enabled roles.","example":[{"description":"Calendars and Contacts provides CalDAV and CardDAV services.","module":"CalendarContact","name":"Calendars and Contacts"},{"description":"Receive Mail allows users to receive email, as well as create and manage their email accounts.","module":"MailReceive","name":"Receive Mail"},{"description":"Send Mail allows users to send email.","module":"MailSend","name":"Send Mail"},{"description":"Local Mail allows the system to process email.","module":"MailLocal","name":"Local Mail"},{"description":"Webmail provides access to webmail services.","module":"Webmail","name":"Webmail"}],"items":{"properties":{"description":{"description":"The role's description.","type":"string"},"module":{"description":"The role's module name.","type":"string"},"name":{"description":"The role's name.","type":"string"}},"type":"object"},"type":"array"},"experimental":{"description":"Whether the profile is experimental.\n\n* `1` — Experimental.\n* `0` — Not experimental.\n\n**Important:**\n\nWe do **not** recommend using experimental profiles on production environments.","enum":[1,0],"example":1,"type":"integer"},"name":{"description":"The name of the system's current server profile.","example":"Mail","type":"string"},"optional_roles":{"description":"The optional roles of the current server profile.","example":[{"description":"DNS allows users to create and edit Domain Name System zone files.","module":"DNS","name":"DNS"},{"description":"Spam Filter allows users to use Apache SpamAssassin™ to identify, sort, and delete unsolicited mail.","module":"SpamFilter","name":"Spam Filter"}],"items":{"properties":{"description":{"description":"The role's description.","type":"string"},"module":{"description":"The role's module name.","type":"string"},"name":{"description":"The role's name.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_current_profile","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return server's node profile","tags":["Server Administration","Server Profiles"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_current_profile\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_current_profile?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"76"}},"/get_available_profiles":{"get":{"description":"This function returns a list of available server profiles.","operationId":"get_available_profiles","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"profiles":{"description":"An array of objects that contains the available server profiles.","example":[{"code":"STANDARD","description":"The Standard Node profile provides all services and access to every cPanel feature.","enabled_roles":[{"description":"Calendars and Contacts provides CalDAV and CardDAV services.","module":"CalendarContact","name":"Calendars and Contacts"},{"description":"DNS allows users to create and edit Domain Name System zone files.","module":"DNS","name":"DNS"},{"description":"FTP allows users to manage the files associated with their site with an FTP client.","module":"FTP","name":"FTP"},{"description":"File Storage allows users to access the File Manager and Git™ Version Control features.","module":"FileStorage","name":"File Storage"},{"description":"Receive Mail allows users to receive email, as well as create and manage their email accounts.","module":"MailReceive","name":"Receive Mail"},{"description":"Send Mail allows users to send email.","module":"MailSend","name":"Send Mail"},{"description":"Local Mail allows the system to process email.","module":"MailLocal","name":"Local Mail"},{"description":"MySQL®/MariaDB allows users to create and manage MySQL/MariaDB databases.","module":"MySQL","name":"MySQL/MariaDB"},{"description":"PostgreSQL allows users to create and manage PostgreSQL databases.","module":"Postgres","name":"PostgreSQL"},{"description":"Spam Filter allows users to use Apache SpamAssassin™ to identify, sort, and delete unsolicited mail.","module":"SpamFilter","name":"Spam Filter"},{"description":"Webmail provides access to webmail services.","module":"Webmail","name":"Webmail"},{"description":"Web Disk allows users to manage and manipulate files on the server with multiple types of devices.","module":"WebDisk","name":"Web Disk"},{"description":"Web Server allows users to create and manage websites for their domains.","module":"WebServer","name":"Web Server"}],"experimental":0}],"items":{"properties":{"code":{"description":"The profile's ID.","example":"MAILNODE","type":"string"},"description":{"description":"The profile's description.","example":"This profile provides only services and cPanel features that allow the system to serve mail.","type":"string"},"disabled_roles":{"description":"The roles that this profile disables. The function returns an empty array if no disabled roles exist.","items":{"properties":{"description":{"description":"The role's description.","example":"File Storage allows users to access the File Manager and Git™ Version Control features.","type":"string"},"module":{"description":"The role's module name.","example":"FileStorage","type":"string"},"name":{"description":"The role's name.","example":"File Storage","type":"string"}},"type":"object"},"type":"array"},"enabled_roles":{"description":"The roles that this profile enables.","items":{"properties":{"description":{"description":"The role's description.","example":"Receive Mail allows users to receive email, as well as create and manage their email accounts.","type":"string"},"module":{"description":"The role's module name.","example":"MailReceive","type":"string"},"name":{"description":"The role's name.","example":"Receive Mail","type":"string"}},"type":"object"},"type":"array"},"experimental":{"description":"Whether the profile is experimental.\n* `1` - Experimental.\n* `0` - **Not** experimental.","enum":[1,0],"example":0,"type":"integer"},"name":{"description":"The profile's name.","example":"Mail","type":"string"},"optional_roles":{"description":"The optional roles that this profile enables. The function returns an empty array if no optional roles exist.","items":{"properties":{"description":{"description":"The role's description.","example":"DNS allows users to create and edit Domain Name System zone files.","type":"string"},"module":{"description":"The role's module name.","example":"DNS","type":"string"},"name":{"description":"The role's name.","example":"DNS","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_available_profiles","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return available server profiles","tags":["Server Administration","Server Profiles"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_available_profiles\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_available_profiles?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"76"}},"/convert_addon_initiate_conversion":{"get":{"description":"This function initiates the conversion process for an addon domain\ninto a cPanel account.\n\n**Note:**\n\nFor information about the data that the system migrates when you convert an\naddon domain, read our\n[Addon Domain Conversion List documentation](https://go.cpanel.net/AddonConversionList).\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"convert_addon_initiate_conversion","parameters":[{"description":"The username for a specified account.","in":"query","name":"username","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The addon domain to convert into an account's main domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The hosting package that you want to assign to the new account.","in":"query","name":"pkgname","required":false,"schema":{"default":"default","example":"mycustompkg","type":"string"}},{"description":"Copy a MySQL® database from the source account to the new account with a new\ndatabase name.\n\nThis parameter's format consists of `copymysqldb`, a hyphen, and the name of\nthe existing database. For example, `copymysqldb-olddatabase`.\n\nIf you do **not** specify this parameter, the system does **not** copy any MySQL\ndatabases to the new account.","examples":{"multiple":{"summary":"Copy multiple databases.","value":"copymysqldb-olddatabase1=newdatabase1 copymysqldb-olddatabase2=newdatabase2"},"single":{"summary":"Copy a single database.","value":"newdatabase"}},"in":"query","name":"copymysqldb-*","required":false,"schema":{"type":"string"}},{"description":"Move the specified MySQL database from the source account to the new account.\n\nIf you do **not** specify this parameter, the system does **not** move any MySQL\ndatabases to the new account.\n\n**Note:**\n\nTo move multiple databases, increment the parameter name. For example, `movemysqldb-1`,\n`movemysqldb-2`, and `movemysqldb-3`.","examples":{"multiple":{"summary":"Move multiple databases.","value":"movemysqldb-1=exampledb1 movemysqldb-2=exampledb2 movemysqluser-3=exampledb3"},"single":{"summary":"Move a single database.","value":"exampledb"}},"in":"query","name":"movemysqldb","required":false,"schema":{"type":"string"}},{"description":"Move the specified MySQL database user from the source account into the new\nMySQL database account.\n\nIf you do **not** specify this parameter, the system does **not** move any MySQL\ndatabase users to the new account.\n\n**Note:**\n\nTo move multiple database users, increment the parameter name. For example, `movemysqluser-1`,\n`movemysqluser-2`, and `movemysqluser-3`.","examples":{"multiple":{"summary":"Move multiple database users.","value":"movemysqluser-1=dbuser1 movemysqluser-2=dbuser2 movemysqluser-3=dbuser3"},"single":{"summary":"Move a single database user.","value":"dbuser1"}},"in":"query","name":"movemysqluser","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"convert_addon_initiate_conversion","type":"string"},"reason":{"description":"The reason the function failed when the `metadata.result` field is `0`. This field may include a success message when the function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The API version of the function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Start additional domain conversion","tags":["Domain Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n convert_addon_initiate_conversion \\\n username='username' \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/convert_addon_initiate_conversion?api.version=1&username=username&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/get_linked_server_node":{"get":{"description":"This function returns details about a linked remote server node.","operationId":"get_linked_server_node","parameters":[{"description":"The name of a linked remote server node.","in":"query","name":"alias","required":true,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"enabled_services":{"description":"The services enabled on the linked remote server node.","items":{"example":"apache_php_fpm","type":"string"},"type":"array"},"hostname":{"description":"The remote server node's hostname.","example":"example.com","format":"domain","type":"string"},"last_check":{"description":"The last time that the server queried the current status of the remote server node.","example":1556576165,"format":"unix_timestamp","type":"integer"},"system_settings":{"additionalProperties":{"type":"object"},"description":"A list of the `worker_capabilities` return's system settings.\nThe key is a role name and the value is an object with system settings for the role.","example":{"Mail":{"globalspamassassin":0}}},"tls_verified":{"description":"Whether the remote server node has a valid SSL certificate.\n* `1` - The remote server node has a valid SSL certificate.\n* `0` - The remote server node does not have a valid SSL certificate.","enum":[0,1],"example":1,"type":"integer"},"username":{"description":"The username required to make API calls to the linked remote server node.","example":"root","format":"username","type":"string"},"version":{"description":"The version of cPanel & WHM installed on the remote server node.","example":"11.86.0.0","type":"string"},"worker_capabilities":{"additionalProperties":{"type":"object"},"description":"A group of services required for a remote server node to perform a specific task. The key is a role name\nand the value is an object with required options for the role.","example":{"Mail":{}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_linked_server_node","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return linked remote server node settings","tags":["Server Administration","Server Nodes"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_linked_server_node \\\n alias='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_linked_server_node?api.version=1&alias=example"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/get_server_node_status":{"get":{"description":"This function returns the status of a linked remote server node. It returns \nthe linked remote server's status with the WHM API 1 `version` and `get_current_profile` functions.","operationId":"get_server_node_status","parameters":[{"description":"The required API token to make API calls to the remote server node.\n\n**Note:**\n\n The API token **must** have `root`-level access on the remote server node.","in":"query","name":"api_token","required":true,"schema":{"example":"23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H","type":"string"}},{"description":"The remote server node's hostname or IP address.\n\n**Note:**\n\nIf you use an IP address, you **must** use the `skip_tls_verification=1` parameter.","in":"query","name":"hostname","required":true,"schema":{"example":"example.com","type":"string"}},{"description":"The username required to make API calls to the remote server node.\n\n**Note:**\n\nThe username **must** have `root`-level access on the remote server node.","in":"query","name":"username","required":true,"schema":{"example":"root","type":"string"}},{"description":"Whether to skip [SSL/TLS verification](https://go.cpanel.net/guidetoSSL). The system performs this action when it queries the remote server node.\n\n* `1` - Skip SSL/TLS verification.\n* `0` - Do **not** skip SSL/TLS verification.","in":"query","name":"skip_tls_verification","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"enabled_services":{"description":"An list of the remote server node's enabled services.","items":{"example":"apache_php_fpm","type":"string"},"type":"array"},"remote_node_linkages":{"description":"An array of objects of the remote server's [child nodes](https://go.cpanel.net/cPanelGlossary#child-node). This function returns this information via the `list_linked_server_nodes` function.\n\n**Note:**\n\nIf you call this function on a parent node for its child node, this function returns an empty object.","items":{"example":{"alias":"MailNode","enabled_services":["apache_php_fpm","cpanellogd","cpdavd","cpgreylistd","cphulkd","cpsrvd","crond","dnsadmin","exim","imap","ipaliases","lmtp","mailman","mysql","named","nscd","pop","queueprocd","rsyslogd","spamd","sshd","tailwatchd"],"hostname":"mailnode.example.com","last_check":1583934071,"system_settings":{"Mail":{"globalspamassassin":"1"}},"tls_verified":0,"username":"root","version":"11.90.0.0","worker_capabilities":{"Mail":{}}},"type":"object"},"type":"array"},"system_settings":{"description":"An object containing the remote server's child node system settings.","example":{"Mail":{"globalspamassassin":1}},"type":"object"},"tls_verified":{"description":"Whether the remote server node has a valid [SSL certificate](https://go.cpanel.net/guidetoSSL).\n* `1` - The remote server node has a valid SSL certificate.\n* `0` - The remote server node does **not** have a valid SSL certificate.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The installed version of cPanel & WHM on the remote server node.","example":"11.90.0.0","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_server_node_status","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return linked server node status","tags":["Server Administration","Server Nodes"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_server_node_status \\\n api_token='23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H' \\\n hostname='example.com' \\\n username='root'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_server_node_status?api.version=1&api_token=23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H&hostname=example.com&username=root"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/list_linked_server_nodes":{"get":{"description":"This function returns a list of all remote server nodes linked to the server. It also provides details about each remote server node.","operationId":"list_linked_server_nodes","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects containing linked remote server nodes data.","items":{"properties":{"alias":{"description":"The name of a linked remote server node.","example":"example","type":"string"},"enabled_services":{"description":"An array of the services enabled on the linked remote server node.","example":["apache_php_fpm","cpanellogd","cpdavd","cpgreylistd","cpsrvd","crond","dnsadmin","exim","ftpd","imap","ipaliases","lmtp","mailman","mysql","named","nscd","pop","postgresql","queueprocd","rsyslogd","spamd","sshd","tailwatchd"],"items":{"type":"string"},"type":"array"},"hostname":{"description":"The remote server node's hostname.","example":"example.com","format":"domain","type":"string"},"last_check":{"description":"The last time that the server queried the current status of the remote server node.","example":1556576165,"format":"unix_timestamp","type":"integer"},"tls_verified":{"description":"Whether the remote server node has a valid [SSL certificate](https://go.cpanel.net/guidetoSSL).\n* `1` — The remote server node has a valid SSL certificate.\n* `0` — The remote server does **not** have a valid SSL certificate.","enum":[0,1],"example":1,"type":"integer"},"username":{"description":"The username required to make API calls to the linked remote server node.","example":"root","format":"username","type":"string"},"version":{"description":"The version of cPanel & WHM installed on the remote server node.","example":"11.90.0.0","format":"cPanel version","type":"string"},"worker_capabilities":{"additionalProperties":{"description":"The current role of the linked remote server node. This will return the required options for the role, if any exist.\n\n**Note:**\n\n* If **no** options exist for the role, this function returns an empty hash.\n* The object's key is the remote server node's current role.","type":"object"},"description":"An object containing groups of services required for a remote server node to fulfill a specific role.","example":{"Mail":{}},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_linked_server_nodes","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all linked server nodes","tags":["Server Administration","Server Nodes"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_linked_server_nodes\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_linked_server_nodes?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/list_user_child_nodes":{"get":{"description":"This function returns the system's cPanel accounts and the [linked cPanel & WHM server](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles) on which they exist.","operationId":"list_user_child_nodes","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"A list of cPanel accounts and the linked cPanel & WHM servers on which they exist.","items":{"properties":{"alias":{"description":"The name (alias) of the linked cPanel & WHM server.","example":"MailServer1","type":"string"},"type":{"description":"The linked [cPanel & WHM server's profile](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles).\n* `Mail` - A server set as a mail node.","enum":["Mail"],"example":"Mail","type":"string"},"user":{"description":"The cPanel account username.","example":"username1","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_user_child_nodes","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel accounts with server name and type","tags":["Server Administration","Server Nodes"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_user_child_nodes\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_user_child_nodes?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"88"}},"/link_server_node_with_api_token":{"get":{"description":"This function links your server to a remote server node. The server uses an API token\nto communicate with the remote server node.\n\n**Important:**\n\n* This function **only** runs on a\n[Standard Node profile](https://go.cpanel.net/whmlinkednodes)\nserver.\n* The remote server node **must** use a version that is the same as or greater than your\nserver version.\n* This function **requires** the use of an API token. For more information, read our\n[Guide to API Authentication - API Tokens in WHM](https://go.cpanel.net/APITokensinWHM)\ndocumentation.","operationId":"link_server_node_with_api_token","parameters":[{"description":"A unique name that refers to the remote server node.\n\n**Note:**\n\nThe alias may **only** contain alphanumeric characters, dashes (`-`), and underscores (`_`).\nIt also has a maximum length of 50 characters.","in":"query","name":"alias","required":true,"schema":{"example":"example","maxLength":50,"minLength":1,"type":"string"}},{"description":"The API token required to make API calls to the remote server node.\n\n**Note:**\n\nThe API token **must** have `root`-level access on the remote server node.","in":"query","name":"api_token","required":true,"schema":{"example":"23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H","type":"string"}},{"description":"The remote server node's hostname.\n\n**Note:**\n\nThis parameter does **not** accept an IP address.","in":"query","name":"hostname","required":true,"schema":{"example":"host.example.com","format":"hostname","type":"string"}},{"description":"The username required to make API calls to the remote server node.\n\n**Note:**\n\nThe username **must** have `root`-level access on the remote server node.","in":"query","name":"username","required":true,"schema":{"example":"root","format":"username","type":"string"}},{"description":"Whether to skip\n[SSL/TLS verification](https://docs.cpanel.net/knowledge-base/security/guide-to-ssl/).\nThe system performs this action when it queries the remote server node.","in":"query","name":"skip_tls_verification","required":false,"schema":{"default":0,"enum":[1,0],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"link_server_node_with_api_token","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add linked server node","tags":["Server Administration","Server Nodes"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n link_server_node_with_api_token \\\n alias='example' \\\n api_token='23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H' \\\n hostname='host.example.com' \\\n username='root'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/link_server_node_with_api_token?api.version=1&alias=example&api_token=23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H&hostname=host.example.com&username=root"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/list_database_users":{"get":{"description":"This function lists the server's database users.\n\n**Warning:**\n\nOn most servers, this function returns a large amount of output. We **strongly** suggest that you filter and sort the output.\n\n**Important:**\n\n When you disable the [MySQL/MariaDB and PostgreSQL roles](https://go.cpanel.net/serverroles) and remote MySQL is not already configured, the system **disables** this function.","operationId":"list_database_users","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of database data objects.","items":{"properties":{"cpuser":{"description":"The database user's owner.","example":"example","type":"string"},"engine":{"description":"The database user's database engine.\n* `mysql`\n* `postgresql`","enum":["mysql","postgresql"],"example":"postgresql","type":"string"},"name":{"description":"The database user's name.","example":"example_user1","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_database_users","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return MySQL users","tags":["Databases","MySQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_database_users\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_database_users?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.44"}},"/listzones":{"get":{"description":"This function lists the server's DNS zones.\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"listzones","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"zone":{"description":"An array of objects of zone information.","items":{"properties":{"domain":{"description":"The domain name.","example":"example.com","format":"domain","type":"string"},"zonefile":{"description":"The zone file's name.","example":"example.net.db","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"listzones","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return server's DNS zones","tags":["DNS","DNS Zones"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n listzones\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/listzones?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/restore_config_from_file":{"get":{"description":"This function restores a configuration backup from a file. If the backup file does **not** contain any changes, the system does **not** write to the configuration file.","operationId":"restore_config_from_file","parameters":[{"description":"The configuration module's name.\n\n**Important:**\n\nThis parameter is case-sensitive. You **must** enter the parameter in the correct case format; otherwise, the function will fail.","in":"query","name":"module","required":true,"schema":{"example":"Main","type":"string"}},{"description":"The absolute path to configuration file.\n\n**Note:**\nIf this parameter contains JSON or equals-sign key and value pairs, they **must** appear in new lines.","in":"query","name":"path","required":true,"schema":{"example":"/var/cpanel/cpanel.config","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"restore_config_from_file","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update configuration file from backup","tags":["Server Administration","Configuration Clusters"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n restore_config_from_file \\\n module='Main' \\\n path='/var/cpanel/cpanel.config'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/restore_config_from_file?api.version=1&module=Main&path=%2fvar%2fcpanel%2fcpanel.config"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"74"}},"/unlink_user_authn_provider":{"get":{"description":"This function unlinks a cPanel account from an external authentication identity provider.","operationId":"unlink_user_authn_provider","parameters":[{"description":"The account's username.","in":"query","name":"username","required":true,"schema":{"example":"example","type":"string"}},{"description":"The system's internal key for the identity provider.","in":"query","name":"provider_id","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":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"unlink_user_authn_provider","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Unregister cPanel account from authentication provider","tags":["Authentication","Authentication Providers"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n unlink_user_authn_provider \\\n username='example' \\\n provider_id='cpanelid' \\\n subject_unique_identifier='123456789012345678901'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/unlink_user_authn_provider?api.version=1&username=example&provider_id=cpanelid&subject_unique_identifier=123456789012345678901"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/set_tweaksetting":{"get":{"description":"This function sets an option's value in WHM's\n[*Tweak Settings*](https://docs.cpanel.net/whm/server-configuration/tweak-settings/)\ninterface (*WHM >> Home >> Server Configuration >> Tweak Settings*). The\nsystem stores the keys and values that this function updates in\nthe\n[`/var/cpanel/cpanel.config`](https://docs.cpanel.net/knowledge-base/cpanel-product/the-cpanel-config-file/)\nfile.","operationId":"set_tweaksetting","parameters":[{"description":"The `cpanel.config` setting name that corresponds to the desired\nsetting in WHM's\n[*Tweak Settings*](https://docs.cpanel.net/whm/server-configuration/tweak-settings/)\ninterface (*WHM >>Home >> Server Configuration >> Tweak Settings*).","in":"query","name":"key","required":true,"schema":{"example":"proxysubdomains","type":"string"}},{"description":"The\n[*Tweak Settings*](https://docs.cpanel.net/whm/server-configuration/tweak-settings/)\ninterface section.\n\n**Note:**\n\nThe possible section names are:\n* `Apache`\n* `Basic`\n* `Mail`\n* `Main`","in":"query","name":"module","required":false,"schema":{"default":"Main","enum":["Apache","Basic","Mail","Main"],"example":"Main","type":"string"}},{"description":"The value to assign to the setting. If you include this parameter in the call but\ndo **not** set a value, the value defaults to an empty value.\n\n**Note:**\n\nFor more information about the requirements for values in the `cpanel.config`\nfile settings, read our\n[`cpanel.config` file](https://docs.cpanel.net/knowledge-base/cpanel-product/the-cpanel-config-file/)\ndocumentation.","in":"query","name":"value","required":false,"schema":{"example":0,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_tweaksetting","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update Tweak Settings option","tags":["Configurations"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_tweaksetting \\\n key='proxysubdomains'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_tweaksetting?api.version=1&key=proxysubdomains"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/start_profile_activation":{"get":{"description":"This function activates a server profile.\n\n**Note:**\n\n* If a server profile enables a service, the system will **also** enable service monitoring. To disable a service's monitoring, use WHM's [*Service Manager*](https://docs.cpanel.net/whm/service-configuration/service-manager/) interface (*WHM >> Home >> Service Configuration >> Service Manager*).\n* For a list of the server's available profiles, use the `get_available_profiles` function.","operationId":"start_profile_activation","parameters":[{"description":"The code value of the server profile.\n\n* `STANDARD` — The Standard profile.\n* `DATABASENODE` — The Database profile.\n* `MAILNODE` — The Mail profile.\n* `DNSNODE` — The DNS profile.","in":"query","name":"code","required":true,"schema":{"enum":["STANDARD","DATABASENODE","MAILNODE","DNSNODE"],"example":"MAILNODE","type":"string"}},{"content":{"application/json":{"schema":{"additionalProperties":{"description":"Each key is a role. Each key **must** have one of the following values:\n\n* `1` — Enable the role.\n* `0` — Disable the role.","enum":[1,0],"example":0,"type":"integer"},"example":{"DNS":0,"SpamFilter":1},"type":"object"}}},"description":"The optional roles to enable or disable with the profile, in\nJSON format. You **must** URI-encode this value.\n\n**Note:**\n\n* As an example, if you wished to enable `SpamFilter` and disable `DNS`, the JSON object would be:\n\n `{ \"SpamFilter\": 1, \"DNS\": 0 }`.\n\n* This parameter does **not** enable optional roles for profiles that do **not** possess any optional roles.\n* If you do not pass this parameter, the system **disables** a profile's optional roles, if any exist.","in":"query","name":"optional","required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"log_id":{"description":"The profile activation log ID. The system creates the log files in the `/var/cpanel/logs/activate_profile/` directory.","example":"17053.10418168.1533478604","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"start_profile_activation","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update server node profile","tags":["Server Administration","Server Profiles"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n start_profile_activation \\\n code='MAILNODE'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/start_profile_activation?api.version=1&code=MAILNODE"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"76"}},"/systemloadavg":{"get":{"description":"This function retrieves the system's load average.\n\n**Note:**\n\nThe values the function returns represent a percentage of the CPU's processor capacity.","operationId":"systemloadavg","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"fifteen":{"description":"The server's load average over the previous fifteen minutes.","example":0.19,"type":"number"},"five":{"description":"The server's load average over the previous five minutes.","example":0.18,"type":"number"},"one":{"description":"The server's load average over the previous minute.","example":0.17,"type":"number"}}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"systemloadavg","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return system load average","tags":["Server Administration","System Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n systemloadavg\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/systemloadavg?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.28"}},"/unlink_server_node":{"get":{"description":"This function unlinks a remote server node from your server.\n\n**Important:**\n\n This function does **not** unlink mail servers that are currently in use. \n You **must** first delete any accounts that use the linked mail server.","operationId":"unlink_server_node","parameters":[{"description":"The name of a linked remote server node.","in":"query","name":"alias","required":true,"schema":{"example":"example","type":"string"}},{"description":"What to do with the linkage’s stored API token on the remote server node:\n\n- `leave`: Leave the API token active.\n- `expire_24h`: Set the API token to expire after 24 hours. This can be undone.","in":"query","name":"handle_api_token","required":false,"schema":{"default":"leave","enum":["leave","expire_24h"],"example":"expire_24h","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"alias":{"description":"The name of a linked remote server node.","example":"example","type":"string"},"enabled_services":{"description":"A list of services enabled on the linked remote server node.","items":{"example":"apache_php_fpm","type":"string"},"type":"array"},"hostname":{"description":"The remote server node's hostname.","example":"example.com","format":"hostname","type":"string"},"last_check":{"description":"The last time that the server queried the current status of the remote server.","example":1556576165,"format":"unix_timestamp","type":"integer"},"system_settings":{"description":"A list of the `worker_capabilities` return's system settings.","example":{"Mail":{"globalspamassassin":"0"}},"properties":{},"type":"object"},"tls_verified":{"description":"Whether the remote server node has a valid [SSL certificate](https://docs.cpanel.net/knowledge-base/security/guide-to-ssl/).\n* `1` - The remote server node has a valid SSL certificate.\n* `0` - The remote server node does not have a valid SSL certificate.","enum":[0,1],"example":1,"type":"integer"},"username":{"description":"The username required to make API calls to the linked remote server node.","example":"root","type":"string"},"version":{"description":"The version of cPanel & WHM installed on the remote server node.","example":"11.86.0.0","type":"string"},"worker_capabilities":{"additionalProperties":{"description":"The current role of the linked remote server node. This will\nreturn the required options for the role, if any exist.\n\n**Note:**\n\nThis return's name is the name of the remote server node's current\nrole.","items":{"type":"string"},"type":"object"},"description":"A group of services required for a remote server node to perform a\nspecific task.","example":{"Mail":{}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"unlink_server_node","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove linked server node","tags":["Server Administration","Server Nodes"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n unlink_server_node \\\n alias='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/unlink_server_node?api.version=1&alias=example"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/update_linked_server_node":{"get":{"description":"This function updates a linked remote cPanel server node.\n\n**Important:**\n\nThis function **requires** the use of an API token. For more information,\nread our [Guide to API Authentication - API Tokens in WHM](https://go.cpanel.net/guide-to-api-authentication-api-tokens-in-whm)\ndocumentation.","operationId":"update_linked_server_node","parameters":[{"description":"The name of a linked remote cPanel server node.","in":"query","name":"alias","required":true,"schema":{"example":"example","type":"string"}},{"description":"The API token required to make API calls to the remote cPanel server node.\n\nThis value defaults to the existing API token.\n\n**Note:**\n\n The API token **must** have `root`-level access on the remote cPanel server node.","in":"query","name":"api_token","required":false,"schema":{"example":"23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H","type":"string"}},{"description":"A new remote cPanel server node's hostname. The system will update your remote\ncPanel server node's hostname to this value.\n\nThis value defaults to the existing hostname.\n\n**Note:**\n\nThis parameter does **not** accept an IP address.","in":"query","name":"hostname","required":false,"schema":{"example":"example.com","type":"string"}},{"description":"The username required to make API calls to the remote cPanel server node.\n\nThis value defaults to the existing username.\n\n**Note:**\n\nThe username **must** have `root`-level access on the remote cPanel server node.","in":"query","name":"username","required":false,"schema":{"example":"root","type":"string"}},{"description":"Whether to skip [SSL/TLS verification](https://docs.cpanel.net/knowledge-base/security/guide-to-ssl/).\nThe system performs this action when it queries the remote cPanel server node.\n\n**Note:**\n\nIf the remote cPanel server is SSL/TLS verified, you **cannot** skip verification.","in":"query","name":"skip_tls_verification","required":false,"schema":{"default":1,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"update_linked_server_node","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update linked server node settings","tags":["Server Administration","Server Nodes"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n update_linked_server_node \\\n alias='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/update_linked_server_node?api.version=1&alias=example"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/list_databases":{"get":{"description":"This function lists the server's databases.\n\n**Warning:**\n\nOn most servers, this function returns a large amount of output. We strongly suggest that you [filter](https://go.cpanel.net/WHMAPI1FilterOutput) and [sort](https://go.cpanel.net/WHMAPI1SortOutput) the output.\n\n**Important:**\n\nWhen you disable the MySQL/MariaDB and PostgreSQL [roles](https://go.cpanel.net/serverroles) and remote MySQL is **not** already configured, the system **disables** this function.","operationId":"list_databases","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects that contain of database data.","items":{"properties":{"cpuser":{"description":"The database's owner.","example":"example","format":"username","type":"string"},"engine":{"description":"The database's engine.\n- `mysql`\n- `postgresql`","enum":["mysql","postgresql"],"example":"postgresql","type":"string"},"name":{"description":"The database's name.","example":"example_db0","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_databases","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return MySQL databases","tags":["Databases","MySQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_databases\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_databases?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.44"}},"/uapi_cpanel":{"get":{"description":"This function calls a UAPI function through the WHM API. This function's output will match the UAPI function that it calls.","operationId":"uapi_cpanel","parameters":[{"description":"The UAPI function to call.\n\n***Note:***\n\nYou must include the UAPI function's required parameters. You can also include its optional parameters.\n\nFor example, to call the UAPI `get_stats` function with its required display parameter and the bandwidthusage and diskusage values:\n\n`display=bandwidthusage|diskusage`","in":"query","name":"cpanel.function","required":true,"schema":{"example":"get_stats","type":"string"}},{"description":"The UAPI function's cPanel module.","in":"query","name":"cpanel.module","required":true,"schema":{"example":"StatsBar","type":"string"}},{"description":"The cPanel username to call with the UAPI function.","in":"query","name":"cpanel.user","required":true,"schema":{"example":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"uapi":{"description":"hash of function output. Each hash contains the returns from the called UAPI function. For information about a function's returns, read the function's documentation.","example":{"data":[{"_count":"0","_max":"unlimited","_maxed":0,"count":"0","feature":"addondomains","id":"addondomains","is_maxed":0,"item":"Addon Domains","max":"unlimited","maxed_phrase":"You are using your maximum allotment ([numf,_1]) of addon domains.","module":"Park","name":"addondomains","near_limit_phrase":"You are using [numf,_1] of [numf,_2] available addon [numerate,_2,domain,domains].","percent":0,"percent10":0,"percent20":0,"percent5":0,"phrase":"Addon Domains","role":"WebServer","zeroisunlimited":0}],"errors":null,"messages":null,"metadata":{"transformed":1},"status":1,"warnings":null},"properties":{"data":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"items":{},"type":"array"},{"type":"object"}],"description":"The UAPI response. This value varies based on the UAPI function requested."},"errors":{"description":"List of errors produced the by the API if any.","items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages produced the by the API if any.","items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"- 1 - A transform was applied.\n- 0 - A transform was not applied.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings produced the by the API if any.","items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"uapi_cpanel","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Run UAPI function through WHM API","tags":["API Execution"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n uapi_cpanel \\\n cpanel.function='get_stats' \\\n cpanel.module='StatsBar' \\\n cpanel.user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/uapi_cpanel?api.version=1&cpanel.function=get_stats&cpanel.module=StatsBar&cpanel.user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/list_mysql_databases_and_users":{"get":{"description":"This function retrieves the MySQL® database and user data for the specified account.\n\n**Important:**\n\nWhen you disable the [MySQL/MariaDB](https://go.cpanel.net/howtouseserverprofiles#roles) role **and** remote MySQL is **not** already configured, the system **disables** this function.","operationId":"list_mysql_databases_and_users","parameters":[{"description":"The username for a specified account.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"mysql_config":{"description":"An object that contains the user's MySQL database configuration settings.","properties":{"mysql-version":{"description":"The MySQL version installed on the server.","example":"5.5","type":"string"},"prefix_length":{"description":"The maximum number of characters allowed for the prefix on this server.","enum":[8,16],"example":8,"type":"integer"},"use_db_prefix":{"description":"Whether database prefixing is enabled on the server.\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"mysql_databases":{"additionalProperties":{"description":"The database's name is the key's name.","items":{"description":"A database username with permissions on the database.","type":"string"},"type":"array"},"description":"An object that contains database names and users.","example":{"user1_database1":["user1_user1"],"user2_database2":["user2_user2"]},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_mysql_databases_and_users","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return MySQL databases and users for account","tags":["Databases","MySQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_mysql_databases_and_users \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_mysql_databases_and_users?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/rename_mysql_user":{"get":{"description":"This function changes a MySQL® database user's name.\n\n**Important:**\n\n When you disable the [*MySQL/MariaDB role*](https://go.cpanel.net/howtouseserverprofiles#roles) **and** remote MySQL is **not** already configured, the system **disables** this function.","operationId":"rename_mysql_user","parameters":[{"description":"The database user's current name.","in":"query","name":"oldname","required":true,"schema":{"example":"username","type":"string"}},{"description":"The database user's new name.\n\n**Warning:**\n\nIf database prefix is enabled, this parameter **must** include the database prefix for the account.","in":"query","name":"newname","required":true,"schema":{"example":"username2","type":"string"}},{"description":"The database user's owner.","in":"query","name":"cpuser","required":false,"schema":{"example":"example","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"rename_mysql_user","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update MySQL username","tags":["Databases","MySQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n rename_mysql_user \\\n oldname='username' \\\n newname='username2'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/rename_mysql_user?api.version=1&oldname=username&newname=username2"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.44"}},"/rename_mysql_database":{"get":{"description":"This function changes a MySQL® database's name. MySQL does **not** allow you to rename a database. When cPanel & WHM \"renames\" a database, the system performs the following steps:\n1. The system creates a new database.\n2. The system moves data from the old database to the new database.\n3. The system recreates grants and stored code in the new database.\n4. The system deletes the old database and its grants.\n\n**Warning:**\n\n* 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.\n* 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.\n\n**Important:**\n\n When you disable the [*MySQL/MariaDB role*](https://go.cpanel.net/howtouseserverprofiles#roles) **and** remote MySQL is **not** already configured, the system **disables** this function.","operationId":"rename_mysql_database","parameters":[{"description":"The database's current name.","in":"query","name":"oldname","required":true,"schema":{"example":"database","type":"string"}},{"description":"The database's new name.\n\n**Warning:**\n\n* If database prefixing is enabled, this parameter **must** include the database prefix for the account.\n* 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.","in":"query","name":"newname","required":true,"schema":{"example":"database2","maxLength":64,"type":"string"}},{"description":"The database's owner.","in":"query","name":"cpuser","required":false,"schema":{"example":"username","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"rename_mysql_database","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update MySQL database name","tags":["Databases","MySQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n rename_mysql_database \\\n oldname='database' \\\n newname='database2'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/rename_mysql_database?api.version=1&oldname=database&newname=database2"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.44"}},"/rename_postgresql_database":{"get":{"description":"This function changes a PostgreSQL® database's name.\n\n**Warning:**\n\n The system requires more time to rename larger and more complex databases.\n\n**Important:**\n\n When you disable the [*PostgreSQL role*](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"rename_postgresql_database","parameters":[{"description":"The database's current name.","in":"query","name":"oldname","required":true,"schema":{"example":"database","type":"string"}},{"description":"The database's new name.\n\n**Warning:**\nIf database prefixing is enabled, this parameter **must** include the database prefix for the account.","in":"query","name":"newname","required":true,"schema":{"example":"database2","type":"string"}},{"description":"The database's owner.","in":"query","name":"cpuser","required":false,"schema":{"example":"username","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"rename_postgresql_database","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update PostgreSQL database name","tags":["Databases","PostgreSQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n rename_postgresql_database \\\n oldname='database' \\\n newname='database2'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/rename_postgresql_database?api.version=1&oldname=database&newname=database2"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.44"}},"/set_mysql_password":{"get":{"description":"This function changes a MySQL® database user's password.\n\n**Important:**\n\nWhen you disable the\n[MySQL/MariaDB role](https://go.cpanel.net/howtouseserverprofiles#roles) **and**\nremote MySQL is **not** already configured, the system **disables** this function.","operationId":"set_mysql_password","parameters":[{"description":"The database username. For information about database username\nrestrictions, read the\n[MySQL](https://dev.mysql.com/) and [MariaDB](https://mariadb.org/)\ndocumentation.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The database user's new password.","in":"query","name":"password","required":true,"schema":{"example":"123456luggage","type":"string"}},{"description":"The cPanel user that controls the database user.","in":"query","name":"cpuser","required":false,"schema":{"example":"example","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_mysql_password","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update MySQL user password","tags":["Databases","MySQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_mysql_password \\\n user='username' \\\n password='123456luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_mysql_password?api.version=1&user=username&password=123456luggage"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.44"}},"/set_postgresql_password":{"get":{"description":"This function changes a PostgreSQL® database user's password.\n\n**Important:**\n\nWhen you disable the [PostgreSQL role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"set_postgresql_password","parameters":[{"description":"The account's username.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}},{"description":"The database user's new password.","in":"query","name":"password","required":true,"schema":{"example":"12345luggage","type":"string"}},{"description":"The database user's owner.","in":"query","name":"cpuser","required":false,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_postgresql_password","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update PostgreSQL user password","tags":["Databases","PostgreSQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_postgresql_password \\\n user='username' \\\n password='12345luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_postgresql_password?api.version=1&user=username&password=12345luggage"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.44"}},"/activate_zone_key":{"get":{"description":"This function activates a domain's DNSSEC security key.","operationId":"activate_zone_key","parameters":[{"description":"The domain for which to activate a security key.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","type":"string"}},{"description":"The security key's ID.\n\n**Note:**\n\nUse the WHM AP1 `fetch_ds_records_for_domains` function to locate the domain's security key ID.","in":"query","name":"key_id","required":true,"schema":{"example":1,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"activate_zone_key","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable domain's DNSSEC key","tags":["DNS","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n activate_zone_key \\\n domain='example.com' \\\n key_id='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/activate_zone_key?api.version=1&domain=example.com&key_id=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/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\n To apply multiple domain DMARC records, duplicate the parameter name. For example, use the `domain=example-1.com`, `domain=example-2.com`, and `domain=example-3.com` parameters.\n\n If you do not include this argument, the system applies the DMARC record to **all** domains on the system.","examples":{"multiple":{"summary":"To apply multiple DMARC records","value":"domain=example-1.com domain=example-2.com domain=example-3.com"},"single":{"summary":"To apply a single domain DMARC record","value":"example.com"}},"in":"query","name":"domain","required":false,"schema":{"type":"string"}},{"description":"The DMARC record to apply to the requested domains.\n\n**Note:**\n\nWhen using multiple policies, each policy must have a matching domain.\n\nWhen using a single policy, it will be applied to all specified domains.\n\nVisit the following link for more information about the DMARC record specification: https://dmarc.org/resources/specification/","examples":{"multiple":{"summary":"To apply multiple DMARC policies, duplicate the policy arguments.","value":"policy=\"v=DMARC1; p=none;\" policy=\"v=DMARC1; p=reject;\" policy=\"v=DMARC1; p=quarantine;\""},"single":{"summary":"To apply a single DMARC record to domains, specify a single policy.","value":"policy=\"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":{"data":{"properties":{"payload":{"description":"An array of objects 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` - The system applied a DMARC record.\n* `0` - The system did **not** apply a DMARC record.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"apply_dmarc","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Apply a DMARC record to a domain","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n apply_dmarc \\\n domain='example.com' \\\n policy='v=DMARC1; p=reject;'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/apply_dmarc?api.version=1&domain=example.com&policy='v=DMARC1; p=reject;'"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"124"}},"/is_alias_available":{"get":{"description":"This function returns whether `ALIAS` and `ANAME` records are available and the value of the running PowerDNS (PDNS) `resolver` setting, if any exists.\nFor more information, read our [`ALIAS` documentation](https://go.cpanel.net/dns-alias-record).","operationId":"DNS::is_alias_available","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"alias":{"description":"Whether `ALIAS` records are available.\n\n* `1` - Available.\n* `0` - Not available.\n\nWhen `ALIAS` records are enabled, they may work in API calls that accept `A` and `AAAA` records. However, the `ALIAS` record must use a fully qualified domain name (FQDN) rather than an IP address.","enum":[1,0],"example":1,"type":"integer"},"aname":{"description":"Whether `ANAME` records are available.\n\n* `1` - Available.\n* `0` - Not available.\n\n**Note:**\n\nThe `aname` value is always set to false (i.e. Not available). The `ANAME` record is currently not supported. It is included for completeness and future proofing.","enum":[1,0],"example":0,"type":"integer"},"resolver":{"description":"The value (if any) of the running PDNS’s `resolver` setting.","example":"8.8.8.8","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"is_alias_available","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return `ALIAS` DNS record availability & resolver","tags":["DNS","Domain Management","Resolvers"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n is_alias_available\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/is_alias_available?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"cPanel 122"}},"/editzonerecord":{"post":{"description":"This function edits a DNS zone record. To effectively use this function, use the following workflow:\n 1. Run the `dumpzone` function on the DNS zone record to edit.\n 1. Locate the `Line` value that corresponds to the data to edit.\n 1. Use the values from that zone record to formulate the appropriate `editzonerecord` parameters.\n\n**Important:**\n\n* When you call this function, you **must** include the additional parameters for the selected zone record type.\n* To change the zone record's IP address, we recommend that you use the [`swapip` script](https://go.cpanel.net/TheswapipScript) or the `setsiteip` function instead.\n* You **cannot** edit other DNS zones that reside on *Write-only* servers in a DNS cluster.\n\n**Note:**\n\nOn servers that run CentOS 7, you may see a `named` warning about the absence of SPF resource records on DNS.\n * This warning is **not** relevant on CentOS 7 servers, because [RFC 7208 deprecated SPF records](https://tools.ietf.org/html/rfc7208). CentOS 7 servers use TXT records instead of SPF records.\n * Red Hat 7.1 and CentOS 7.1 both contain `bind-9.9.4-23.el7`, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the [Red Hat Bugzilla case about SPF record errors](https://bugzilla.redhat.com/show_bug.cgi?id=1215164).\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"editzonerecord","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DnsEditZoneParameterType"}}},"description":"The updated DNS Zone Record.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"editzonerecord","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Bind reloading on hostname using rndc zone: [example.com]\n","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update DNS zone record","tags":["DNS","DNS Zones"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --input=json --output=jsonpretty \\\n editzonerecord\n"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/json-api/editzonerecord HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 0\n\n"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/disable_dnssec_for_domains":{"get":{"description":"This function disables DNSSEC on the domain.\n\n**Note:**\n\n Only servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn't use PowerDNS, you will receive an error.\n\n**Warning:**\n\n - This action is **irreversible**. If you disable DNSSEC on the domain, you will lose the associated keys. You can only retrieve the keys by restoring them from a full back up of the account.\n - If you disable DNSSEC, you **must** remove the Delegation of Signing (DS) records on your DNS server and with your registrar.","operationId":"disable_dnssec_for_domains","parameters":[{"description":"The domain for which to disable DNSSEC.\n\n**Note:**\n\nTo disable DNSSEC for multiple domains, duplicate or increment the parameter name. For example, to check three domains, you could:\n\n* Use the `domain` parameter multiple times.\n* Use the `domain`, `domain-1`, `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":{"format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"domains":{"description":"An array of objects that contains information about each domain.","items":{"properties":{"disabled":{"description":"Whether the system disabled DNSSEC.\n* `1` - Disabled.\n* `0` - The system failed to disable DNSSEC.","enum":[0,1],"example":1,"type":"integer"},"domain":{"description":"The domain for which the system disabled DNSSEC.","example":"example.com","format":"domain","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"disable_dnssec_for_domains","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable DNSSEC on domain","tags":["DNS","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n disable_dnssec_for_domains \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/disable_dnssec_for_domains?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/deactivate_zone_key":{"get":{"description":"This function deactivates a domain's DNSSEC security key.\n\n**Note:**\n\nOnly servers that run PowerDNS can use DNSSEC. If you call this function on a server\nthat doesn't use PowerDNS, you will receive an error.","operationId":"deactivate_zone_key","parameters":[{"description":"The domain for which to deactivate a security key.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","type":"string"}},{"description":"The security key's ID.\n\n**Note:**\n\nUse the WHM AP1 `fetch_ds_records_for_domains` function to locate the\ndomain's security key ID.","in":"query","name":"key_id","required":true,"schema":{"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"deactivate_zone_key","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable domain's DNSSEC key","tags":["DNS","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n deactivate_zone_key \\\n domain='example.com' \\\n key_id='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/deactivate_zone_key?api.version=1&domain=example.com&key_id=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/remove_dmarc":{"get":{"description":"This function removes the DMARC DNS record from a domain.","operationId":"EmailAuth::remove_dmarc","parameters":[{"description":"The domain for 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.\n\nTo remove multiple domain DMARC records, duplicate the parameter name. For example, use the `domain=example-1.com`, `domain=example-2.com`, and `domain=example-3.com` parameters.","examples":{"multiple":{"summary":"To remove multiple domain DMARC records","value":"domain=example-1.com domain=example-2.com domain=example-3.com"},"single":{"summary":"To remove a single domain DMARC record","value":"example.com"}},"in":"query","name":"domain","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects that contains information about the DMARC records that were removed.","items":{"properties":{"domain":{"description":"The domain for which the system removed the DMARC record.","example":"example.com","type":"string"},"msg":{"description":"Information about the removed DMARC record.","example":"[REMOVE:TXT@_dmarc.exmaple.com:v=DMARC1; p=reject;]","type":"string"},"status":{"description":"Whether the system removed the domain's DMARC record on the DNS server.\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"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"remove_dmarc","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove domains' DMARC records.","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n remove_dmarc \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remove_dmarc?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"124"}},"/rename_postgresql_user":{"get":{"description":"This function changes a PostgreSQL® database user's name.\n\n**Important:**\n\n When you disable the [*PostgreSQL role*](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"rename_postgresql_user","parameters":[{"description":"The database user's current name.","in":"query","name":"oldname","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The database user's new name.\n\n**Warning:**\nIf database prefix is enabled, this parameter **must** include the database prefix for the account.","in":"query","name":"newname","required":true,"schema":{"example":"username2","type":"string"}},{"description":"The database user's new password.","in":"query","name":"password","required":true,"schema":{"example":"12345luggage","type":"string"}},{"description":"The database user's owner.","in":"query","name":"cpuser","required":false,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"rename_postgresql_user","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update PostgreSQL username","tags":["Databases","PostgreSQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n rename_postgresql_user \\\n oldname='username' \\\n newname='username2' \\\n password='12345luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/rename_postgresql_user?api.version=1&oldname=username&newname=username2&password=12345luggage"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.44"}},"/enable_dnssec_for_domains":{"get":{"description":"This function enables DNSSEC on the domain.\n\n**Note:**\n\n* Only servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn't use PowerDNS, you will receive an error.\n* After you enable DNSSEC on the domain, you **must** add the Delegation of Signing (DS) records on your DNS server and with your registrar.\n* You **cannot** modify the DNSSEC security key. To make any changes, you **must** disable, delete, and re-create the DNSSEC security key.","operationId":"enable_dnssec_for_domains","parameters":[{"description":"The domain for which to enable DNSSEC.\n\n**Note:**\n\nTo enable DNSSEC on multiple domains, duplicate or increment the parameter name. For example, to check 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":"example.com","format":"domain","type":"string"}},{"description":"Whether to activate the newly-created key.\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"}},{"description":"The algorithm that the system uses to generate the security key.\n* `5` - RSA/SHA-1\n* `6` - DSA-NSEC3-SHA1\n* `7` - RSASHA1-NSEC3-SHA1\n* `8` - RSA/SHA-256\n* `10` - RSA/SHA-512\n* `13` - ECDSA Curve P-256 with SHA-256\n* `14` - ECDSA Curve P-384 with SHA-384\n\n**Note:**\n\nWe recommend that you use an ECDSA Curve P-256 with SHA-256 (13) value if your registrar supports it.","in":"query","name":"algo_num","required":false,"schema":{"default":8,"enum":[5,6,7,8,10,13,14],"example":8,"type":"integer"}},{"description":"The manner in which the system creates the security key.\n* `classic` - Use separate keys for KSK and ZSK. Use this value when the `algo_num` parameter is equal to or less than 8.\n* `simple` - Use a single key for both KSK and ZSK. Use this value when the `algo_num` parameter is greater than 8.","in":"query","name":"key_setup","required":false,"schema":{"default":"classic","enum":["classic","simple"],"example":"classic","type":"string"}},{"description":"Whether the domain will use [Next Secure Record](https://tools.ietf.org/html/rfc4470) (NSEC) or NSEC3 semantics.\n* `1` - Use NSEC3 semantics.\n* `0` - Use NSEC semantics.\n\n**Note:**\n\nIf you use this value, 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":"The number of times that the system rehashes the first resource record hash operation.","in":"query","name":"nsec3_iterations","required":false,"schema":{"default":7,"example":7,"maximum":500,"minimum":1,"type":"integer"}},{"description":"Whether NSEC3 operates in Narrow or Inclusive mode.\n\n**Note:**\n\nFor information about these modes, read [PowerDNS's DNSSEC documentation](https://doc.powerdns.com/authoritative/dnssec/intro.html).\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":"Whether the system will create records for all delegations.\n* `1` - Create records for all delegations.\n* `0` - Create records only for secure delegations.\n\n**Note:**\n\nOnly use the `1` value if you **must** create records for all delegations.","in":"query","name":"nsec3_opt_out","required":false,"schema":{"default":0,"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.\n\n**Note:**\n\nFor information about salt values, read [RFC 5155](https://tools.ietf.org/html/rfc5155#section-3.1.5).","in":"query","name":"nsec3_salt","required":false,"schema":{"example":"1a2b3c4d5e6f","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"domains":{"description":"An array of objects that contains information about each domain.","items":{"properties":{"domain":{"description":"The domain for which the system enabled DNSSEC.","example":"example.com","format":"domain","type":"string"},"enabled":{"description":"Whether the system enabled DNSSEC.\n* `1` - Enabled.\n* `0` - The system failed to enable DNSSEC.\n\n**Note:**\n\nThis function will **not** return the `nsec_version` and `new_key_id` returns if this return is a `0` value.","enum":[0,1],"example":1,"type":"integer"},"new_key_id":{"description":"The assigned security key ID. A valid ID.","example":"2","type":"string"},"nsec_error":{"description":"The domain has a NSEC3 configuration error.\n\n**Note:**\n\nThe function **only** displays this return if there is a NSEC3 configuration error. An error message.","example":"Error message.","type":"string"},"nsec_version":{"description":"The version of DNSSEC the system used.\n* `NSEC3`\n* `NSEC`\n\n**Note:**\n\nThe function only displays this return if there is a NSEC3 configuration error. The system also returns the error in the `nsec_error` return.","enum":["NSEC3","NSEC"],"example":"NSEC3","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"enable_dnssec_for_domains","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable DNSSEC on domain","tags":["DNS","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n enable_dnssec_for_domains \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/enable_dnssec_for_domains?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/fetch_ds_records_for_domains":{"get":{"description":"This function fetches a domain's Delegation of Signing (DS) record.\n\n**Note:**\n\nOnly servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn't use PowerDNS, you will receive an error.","operationId":"fetch_ds_records_for_domains","parameters":[{"description":"The domain to fetch a DS record from.\n\n**Note:**\n\nTo fetch records from multiple domains, duplicate or increment the parameter name. For example, to check 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":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"domains":{"description":"An array of objects that contains information about each domain.","items":{"properties":{"domain":{"description":"The domain name.","example":"example.com","format":"domain","type":"string"},"ds_records":{"description":"An object that contains domain's DS records.\n\n**Note:**\n\nIf the domain does **not** have a DS record, this function returns an empty object.","example":{"keys":{"40481":{"active":1,"algo_desc":"RSA/SHA-256","algo_num":8,"algo_tag":"RSASHA256","bits":2048,"created":1575395316,"digests":[{"algo_desc":"SHA-1","algo_num":1,"digest":"2808a14b89118256119d93d24b9e6b673dca092b"},{"algo_desc":"SHA-256","algo_num":2,"digest":"02a57812deb952438382ed8dd20f00d4af844a55b5324d28bb"},{"algo_desc":"SHA-384","algo_num":4,"digest":"4569a6fcfe9e151ec6a163307e67eaa3a9547f16cd80751b0d46eb498bd96743bd4ff7c4f6fd5f76cc780aeb979cd08d"}],"flags":257,"key_id":1,"key_tag":40481,"key_type":"KSK","privatekey":"Private-key-format: v1.2\nAlgorithm: 8 (RSASHA256)\nModulus: syUlztxieV1aOtuYAGGA4VBxgquwqPTWQXcDVY1VRFcPgFmLMWYr6dDnN4OUhu2yIulK3KMeZmAc/DmwM+yNdCdYc9y84gw5OyONKduuPGYXfwCiJfOJ+NpGaFomK6fVFN8BMi6LUBytdA4gotPw45Uz8FIbl1KsEOnV4/ZpjiM=\nPublicExponent: AQAB\nPrivateExponent: LxIfsQ7vQPxqbPSuJ8t21b0RVkhOjtZmRaVD1wLf2KkXhZ4BmOVDvJgLaObF6/4gxFOQPBEQN84hT5TI25vYPrAwRAlP/yGmQ4Z2aPIYeEawoqqNoYEa5Xjs1X90i6/+Y8mJSZpGvr4/Y4ElothZTUw+LCYb6o9ulg53yya8KUE=\nPrime1: 4od92Rbx9fSXRIk6eSSdTYN/Do3zgDiCuxmuZaCrrEAlkiK11iz/s4aZGj9+Yk4NfusjXr3NqU1OMfBiIp67Sw==\nPrime2: ynOJdz/E4/B6iBtuz/4y0kasljMtiJnaNIxPr4LG+hByx7WWCnaPm6p8g1pz3FC/w7HAdWq9xzR1VnbRPGcZiQ==\nExponent1: KUKmkIEWZ0c6ujgIl4IsyK6X2O3QGV2xqiSeWFJwknpInZqG5lDh7jAo+NfxzDQNTz3C/oGx0RGMmZoANfAViw==\nExponent2: ZcFkmpdmstqv+7EuJUSy7pWvMV9Px5Ts4/SSKLkmoZGa314Zp/CnhapPIwZXrai4effhsCKSeImZYHgf+qgnYQ==\nCoefficient: PBQUQquZB0kG//cy8oVA6nHvKkvVJ8zV4GVlkXHTDylbjoWBTuNWwQ93t5SM7Rz3JePHImWdOVMYNIXpPlp56g==\n"}},"nsec_details":{"nsec3_hash_algo_desc":"SHA-1","nsec3_hash_algo_num":1,"nsec3_iterations":7,"nsec3_narrow":1,"nsec3_opt_out":0,"nsec3_salt":"1a2b3c4d5e6f","nsec_version":"NSEC3"}},"properties":{"keys":{"additionalProperties":{"description":"Each key/value property includes information related the domain's DNSSEC record.","properties":{"active":{"description":"Whether the DS key is active.\n* `1` - Active.\n* `0` - Inactive.","enum":[0,1],"example":1,"type":"integer"},"algo_desc":{"description":"A description of the algorithm that the DS key uses.","example":"RSA/SHA-256","type":"string"},"algo_num":{"description":"The [Internet Engineering Task Force](https://www.ietf.org/) (IETF)-recognized DNSSEC Digest Algorithm Number.\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,"format":"bits","type":"integer"},"created":{"description":"The key's creation time, in [Unix time format](https://en.wikipedia.org/wiki/Unix_time).\n* `0` - The creation time is unknown.\n* A valid timestamp, in Unix epoch time.","example":1575395316,"format":"unix_timestamp","type":"integer"},"digests":{"description":"An array of objects of information the registrar uses to populate DS records.","items":{"properties":{"algo_desc":{"description":"A description of the algorithm that the DS record uses.","example":"SHA-1","type":"string"},"algo_num":{"description":"The IETF-recognized DNSSEC Algorithm Number.","example":1,"minimum":1,"type":"integer"},"digest":{"description":"The actual digest in the DS record.","example":"2808a14b89118256119d93d24b9e6b673dca092b","type":"string"}},"type":"object"},"type":"array"},"flags":{"description":"An integer that determines the `key_type` value.\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 integer value.","example":40481,"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 private key in ISC format.","example":"Private-key-format: v1.2\nAlgorithm: 8 (RSASHA256)\nModulus: syUlztxieV1aOtuYAGGA4VBxgquwqPTWQXcDVY1VRFcPgFmLMWYr6dDnN4OUhu2yIulK3KMeZmAc/DmwM+yNdCdYc9y84gw5OyONKduuPGYXfwCiJfOJ+NpGaFomK6fVFN8BMi6LUBytdA4gotPw45Uz8FIbl1KsEOnV4/ZpjiM=\nPublicExponent: AQAB\nPrivateExponent: LxIfsQ7vQPxqbPSuJ8t21b0RVkhOjtZmRaVD1wLf2KkXhZ4BmOVDvJgLaObF6/4gxFOQPBEQN84hT5TI25vYPrAwRAlP/yGmQ4Z2aPIYeEawoqqNoYEa5Xjs1X90i6/+Y8mJSZpGvr4/Y4ElothZTUw+LCYb6o9ulg53yya8KUE=\nPrime1: 4od92Rbx9fSXRIk6eSSdTYN/Do3zgDiCuxmuZaCrrEAlkiK11iz/s4aZGj9+Yk4NfusjXr3NqU1OMfBiIp67Sw==\nPrime2: ynOJdz/E4/B6iBtuz/4y0kasljMtiJnaNIxPr4LG+hByx7WWCnaPm6p8g1pz3FC/w7HAdWq9xzR1VnbRPGcZiQ==\nExponent1: KUKmkIEWZ0c6ujgIl4IsyK6X2O3QGV2xqiSeWFJwknpInZqG5lDh7jAo+NfxzDQNTz3C/oGx0RGMmZoANfAViw==\nExponent2: ZcFkmpdmstqv+7EuJUSy7pWvMV9Px5Ts4/SSKLkmoZGa314Zp/CnhapPIwZXrai4effhsCKSeImZYHgf+qgnYQ==\nCoefficient: PBQUQquZB0kG//cy8oVA6nHvKkvVJ8zV4GVlkXHTDylbjoWBTuNWwQ93t5SM7Rz3JePHImWdOVMYNIXpPlp56g==\n","type":"string"}},"type":"object"},"description":"An object containing the DS keys on the requested domain.","type":"object"},"nsec_details":{"description":"An object with of the domain's [Next Secure Record](https://tools.ietf.org/html/rfc4470) (NSEC) information.\n\n**Note:**\n\nIf the domain uses NSEC semantics, only the `nsec_version` return appears in this object.","properties":{"nsec3_hash_algo_desc":{"description":"description of the NSEC3 key's algorithm.","example":"SHA-1","type":"string"},"nsec3_hash_algo_num":{"description":"The DNSSEC ([Domain Name Security Extensions](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions)) Digest Algorithm Number.","example":1,"minimum":1,"type":"integer"},"nsec3_iterations":{"description":"The number of times that the system rehashes the first hash operation.","example":7,"minimum":1,"type":"integer"},"nsec3_narrow":{"description":"Whether NSEC3 will operate in Narrow or Inclusive mode.\n\n**Note:**\n\nFor more information about these modes, read [PowerDNS's DNSSEC documentation](https://doc.powerdns.com/authoritative/dnssec/intro.html).\n* `1` - Narrow mode.\n* `0` - Inclusive mode.","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* `1` - Create records for all delegations.\n* `0` - Create records **only** for secure delegations.","enum":[0,1],"example":0,"type":"integer"},"nsec3_salt":{"description":"The salt value that PowerDNS uses in the hashes.\n\n**Note:**\n\nFor more information about salt values, read [RFC 5155](https://tools.ietf.org/html/rfc5155#section-3.1.5).","example":"1a2b3c4d5e6f","type":"string"},"nsec_version":{"description":"Whether the domain uses NSEC or NSEC3 ([Next Secure Record version 3](https://tools.ietf.org/html/rfc5155)) DNSSEC semantics.","enum":["NSEC","NSEC3"],"example":"NSEC3","type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"fetch_ds_records_for_domains","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domain's DS record","tags":["DNS","Domain Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n fetch_ds_records_for_domains \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_ds_records_for_domains?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/export_zone_key":{"get":{"description":"This function exports a DNSSEC security key to a domain.\n\n**Note:**\n\nOnly servers that run PowerDNS can use DNSSEC. If you call this function on a server\nthat doesn't use PowerDNS, you will receive an error.","operationId":"export_zone_key","parameters":[{"description":"The domain to export the security key to.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","type":"string"}},{"description":"The security key's ID.\n\n**Note:**\n\nYou can locate the ID with the WHM AP1 `fetch_ds_records_for_domains` function.","in":"query","name":"key_id","required":true,"schema":{"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"key_tag":{"description":"The security key's integer value.","example":40481,"type":"integer"},"key_type":{"description":"The type of security key.\n\n* `CSK` — Combined Signing Key.\n* `KSK` — Key Signing Key.\n* `ZSK` — Zone Signing Key.","example":"CSK","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"export_zone_key","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Export domain's DNSSEC key","tags":["DNS","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n export_zone_key \\\n domain='example.com' \\\n key_id='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/export_zone_key?api.version=1&domain=example.com&key_id=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/has_local_authority":{"get":{"description":"This function checks whether the local server has the authority to publish changes for the domain's DNS records.\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"has_local_authority","parameters":[{"description":"The domain to check whether the local server is authoritative for the domain's DNS records.\n\n**Note:**\n\nTo check multiple domains, duplicate or increment the parameter name. For example, to check three domains, use the `domain` parameter multiple times. Or 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"},"single":{"summary":"A single domain","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"records":{"description":"An array of objects that contains information about about the authoritative status of a domain's local DNS zone files.","items":{"properties":{"domain":{"description":"The queried domain.","example":"example.com","type":"string"},"error":{"description":"A message that details the reason why the local server's authoritative check failed.\n\n**Note:**\n\n The function **only** returns this value when the check fails.","example":"(XID qdbmuk) DNS query (example3.com/SOA) timeout!","type":"string"},"local_authority":{"description":"Whether the local server is authoritative for the domain's DNS records.\n* `1` — The local server is authoritative for the domain's DNS records.\n* `0` — The local server is **not** authoritative for the domain's DNS records.","enum":[0,1],"example":1,"type":"integer"},"nameservers":{"description":"The domain's authoritative nameservers, if any exist.","example":["ns1.example.com","ns2.example.com"],"items":{"format":"domain","type":"string"},"type":"array"},"zone":{"description":"The DNS zone that contains the domain's DNS records, if one exists.","example":"example.com","format":"domain","nullable":true,"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"has_local_authority","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate local server is authoritative","tags":["DNS","Domain Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n has_local_authority \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/has_local_authority?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"78"}},"/backup_config_get":{"get":{"description":"This function retrieves your backup destination configuration file data.","operationId":"backup_config_get","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"backup_config":{"description":"A list of backup configuration data.","properties":{"backup_daily_enable":{"description":"Whether daily backups are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":1,"type":"integer"},"backup_daily_retention":{"description":"The number of retained daily backups.","example":5,"minimum":1,"type":"integer"},"backup_monthly_dates":{"description":"A comma-seprated list of the days of the month on which the system runs monthly backups.","example":"1,15,22","type":"string"},"backup_monthly_enable":{"description":"Whether monthly backups are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":0,"type":"integer"},"backup_monthly_retention":{"description":"The number of retained monthly backups.","example":5,"minimum":1,"type":"integer"},"backup_weekly_day":{"description":"The day of the week on which the system runs weekly backups.\n\n* `0` — Sunday.\n* `1` — Monday.\n* `2` — Tuesday.\n* `3` — Wednesday.\n* `4` — Thursday.\n* `5` — Friday.\n* `6` — Saturday.","example":"1,3,5","type":"string"},"backup_weekly_enable":{"description":"Whether weekly backups are enabled.\n\n* `1` — Enable.\n* `0` — Disable.","enum":[0,1],"example":0,"type":"integer"},"backup_weekly_retention":{"description":"The number of retained weekly backups.","example":4,"minimum":1,"type":"integer"},"backupaccts":{"description":"Whether to back up accounts.\n\n* `1` — Back up.\n* `0` — Do **not** back up.\n\n**Note:**\n\nThis setting affects whether the system enables the *File and\nDirectory Restoration* interface in cPanel & WHM. For more\ninformation, read the\n[How to Manage Metadata Settings](https://go.cpanel.net/MetadataSettings)\ndocumentation.","enum":[1,0],"example":1,"type":"integer"},"backupbwdata":{"description":"Whether bandwidth tracking data backups are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":1,"type":"integer"},"backupdays":{"description":"The days of the week on which the system runs daily backups.\n\n* `0` — Sunday.\n* `1` — Monday.\n* `2` — Tuesday.\n* `3` — Wednesday.\n* `4` — Thursday.\n* `5` — Friday.\n* `6` — Saturday.","example":"0,2,4,6","type":"string"},"backupdir":{"description":"The aboslute file path to the server's local backup directory.","example":"/backup","type":"string"},"backupenable":{"description":"Whether backups are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[1,0],"example":1,"type":"integer"},"backupfiles":{"description":"Whether system file backups are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":1,"type":"integer"},"backuplogs":{"description":"Whether error log backups are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":0,"type":"integer"},"backupmount":{"description":"Whether the system mounts backup partitions as part of the\nbackup process.\n\n* `1` — Mounted.\n* `0` — **Not** mounted.\n\n**Note:**\n\nThis setting affects whether the system enables the *File and\nDirectory Restoration* interface in cPanel & WHM. For more\ninformation, read the\n[How to Manage Metadata Settings](https://go.cpanel.net/MetadataSettings)\ndocumentation.","enum":[0,1],"example":0,"type":"integer"},"backupsuspendedaccounts":{"description":"Whether suspended account backups are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":0,"type":"integer"},"backuptype":{"description":"The type of backup file the system creates.\n\n* `compressed` — A compressed `.tar` file.\n* `uncompressed` — An uncompressed `.tar` file.\n* `incremental` — A full tree of files and directories.","enum":["compressed","uncompressed","incremental"],"example":"compressed","type":"string"},"check_min_free_space":{"description":"Whether the system performs a check of the minimum free disk space\navailable on the destination server.\n\n* `1` — Check the free disk space on the destination server.\n* `0` — Do **not** check the free disk space on the destination\nserver.","enum":[0,1],"example":1,"type":"integer"},"disable_metadata":{"description":"Whether the backup system creates metadata when a backup runs.\n\n* `1` — Disables metadata creation.\n* `0` — Enables metadata creation.","enum":[1,0],"example":0,"type":"integer"},"errorthreshhold":{"description":"The number of times that the system attempts to use the additional backup destination.","example":3,"minimum":1,"type":"integer"},"force_prune_daily":{"description":"Whether the `backup_daily_retention` parameter is strictly enforced.\n\n* `1` — Enforced.\n* `0` — The system **only** enforces the `backup_daily_retention`\nsetting after a backup successfully completes.","enum":[0,1],"example":0,"type":"integer"},"force_prune_monthly":{"description":"Whether the `backup_monthly_retention` parameter is strictly enforced.\n\n* `1` — Enforced.\n* `0` — The system **only** enforces the `backup_monthly_retention`\nsetting after a backup successfully completes.","enum":[0,1],"example":0,"type":"integer"},"force_prune_weekly":{"description":"Whether the `backup_weekly_retention` parameter is strictly enforced.\n\n* `1` — Enforced.\n* `0` — The system **only** enforces the `backup_weekly_retention`\nsetting after a backup successfully completes.","enum":[0,1],"example":0,"type":"integer"},"gziprsyncopts":{"description":"The environment variables passed to the `gzip` application. The system uses these variables to adjust how the `gzip` application runs when compressing backups.","example":"--rysncable","type":"string"},"keeplocal":{"description":"Whether the system deletes backups from the local directory.\n\n* `1` — The system does not delete backups from the local backup\ndirectory.\n* `0` — The system **deletes** backups from the local\ndirectory.\n\n**Note:**\n\nThe `backupdir` return value contains the local backup directory.","enum":[0,1],"example":1,"type":"integer"},"linkdest":{"description":"Whether the system checks the `rsync` function for hardlink support.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":0,"type":"integer"},"localzonesonly":{"description":"Whether the system uses a local zone file from the `dnsadmin` daemon\nor `/var/named/domain.tld` file, where `domain.tld` is the target domain.\n\n* `1` — The system uses the `/var/named/domain.tld` file.\n* `0` — The system uses the `dnsadmin` daemon.","enum":[0,1],"example":0,"type":"integer"},"maximum_restore_timeout":{"description":"The maximum interval, in seconds, that the restoration attempts a run to completion. If the restoration takes longer than this interval, the system terminates the restoration.","example":21600,"minimum":1,"type":"integer"},"maximum_timeout":{"description":"The maximum interval, in seconds, that the backup attempts a run to completion. If the backup takes longer than this interval, the system terminates the backup.","example":7200,"minimum":1,"type":"integer"},"min_free_space":{"description":"The minimum amount of free disk space the system checks for on the destination server before attempting a backup to that server.","example":1024,"minimum":1,"type":"integer"},"min_free_space_unit":{"description":"The unit of measure of disk space for the `min_free_space` return.\n\n* `MB` — Megabytes.\n* `percent` — Percentages.","enum":["MB","percent"],"example":"MB","type":"string"},"mysqlbackup":{"description":"The method that the system uses to back up MySQL® databases.\n\n* `accounts` — Backs up databases into each account's archive.\n* `dir` — Backs up the entire MySQL directory.\n* `both` — Back up databases into each account's archive **and**\nthe entire MySQL directory.","example":"accounts","type":"string"},"postbackup":{"description":"Whether the `/usr/local/cpanel/scripts/postcpbackup` script runs\nafter the backup completes.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":0,"type":"integer"},"prebackup":{"description":"Whether the `/usr/local/cpanel/scripts/precpbackup` script runs before\nthe system processes backups.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":1,"type":"integer"},"psqlbackup":{"description":"Whether backups of PostgreSQL® databases are enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":0,"type":"integer"},"remote_restore_staging_dir":{"description":"The directory on the local server where the system temporarily\nstores a remote server's backup file during a backup restoration.","example":"/backup","type":"string"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_config_get","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return backup configuration file data","tags":["Backups","Backup Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_config_get\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_config_get?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.38"}},"/import_zone_key":{"get":{"description":"This function imports a DNSSEC security key.\n\n**Note:**\n\nOnly servers that run PowerDNS can use DNSSEC. If you call this function on a server\nthat doesn't use PowerDNS, you will receive an error.","operationId":"import_zone_key","parameters":[{"description":"The domain for which to import the security key.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","type":"string"}},{"description":"The security key's type.\n\n* `ksk` — Key-Signing Key\n* `zsk` — Zone Signing Key\n\n**Note:**\n\nYou **must** call these values in lowercase.","in":"query","name":"key_type","required":true,"schema":{"example":"ksk","type":"string"}},{"description":"The security key's data that the\n[pdnsuti](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":{"data":{"properties":{"import_key_id":{"description":"The system's assigned ID for the imported security key.","example":1,"minimum":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"import_zone_key","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Import DNSSEC key","tags":["DNS","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty import_zone_key domain='example.com' key_type='ksk' key_data='Private-key-format:%20v1.2%0AAlgorithm:%2013%20\\(ECDSAP256SHA256\\)%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/import_zone_key?api.version=1&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"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/remove_zone_key":{"get":{"description":"This function removes a DNSSEC security key.\n\n**Note:**\n\nOnly servers that run PowerDNS can use DNSSEC. If you call this function on a server\nthat doesn't use PowerDNS, you will receive an error.","operationId":"remove_zone_key","parameters":[{"description":"The domain for which to remove a security key.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","type":"string"}},{"description":"The security key's ID.\n\n**Note:**\n\nUse the WHM AP1 `fetch_ds_records_for_domains` function to locate the domain's\nsecurity key ID.","in":"query","name":"key_id","required":true,"schema":{"example":1,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"remove_zone_key","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove DNSSEC key","tags":["DNS","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n remove_zone_key \\\n domain='example.com' \\\n key_id='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remove_zone_key?api.version=1&domain=example.com&key_id=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/removezonerecord":{"get":{"description":"This function deletes a DNS zone record.\n\n**Warning:**\n\nIncorrect use of this function could cause domains to resolve incorrectly. Exercise **extreme caution** when you remove DNS zone records.\n\nTo effectively use this function, use the following workflow:\n1. Run the `dumpzone` function.\n2. Locate the `Line` value that corresponds to the zone record to delete.\n3. Use the values from that zone record to formulate the appropriate `removezonerecord` parameters.\n\n**Important:**\n\n When you disable the [DNS role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"removezonerecord","parameters":[{"description":"The zone record's domain.","in":"query","name":"zone","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The DNS zone record file's line number.","in":"query","name":"line","required":true,"schema":{"example":4,"minimum":1,"type":"integer"}},{"description":"The zone file's serial number.\n\nThis parameter defaults to the zone file's current serial number.","in":"query","name":"serialnum","required":false,"schema":{"example":"2013122501","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"removezonerecord","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Bind reloading on hostname using rndc zone: [example.com]\n","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete DNS zone record","tags":["DNS","DNS Zones"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n removezonerecord \\\n zone='example.com' \\\n line='4'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/removezonerecord?api.version=1&zone=example.com&line=4"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/resetzone":{"get":{"description":"This function resets a DNS zone to its default values. This also resets the domain's subdomain DNS records, and restores zone file subdomains in the server's `httpd.conf` file. For example, use this function to restore DNS zones that are corrupt.\n\n**Note:**\n\nZone resets preserve valid TXT records, but **all** other records will return to their default values.\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/serverroles), the system **disables** this function.\n\n**Note**\n\nYou **must** include either the `domain` or the `zone` parameters.","operationId":"resetzone","parameters":[{"description":"The domain.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The zone file.","in":"query","name":"zone","required":false,"schema":{"example":"example.com.db","type":"string"}},{"description":"The domain's owner.","in":"query","name":"user","required":false,"schema":{"example":"user","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"resetzone","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason `field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Restore DNS zone to default values","tags":["DNS","Domain Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n resetzone\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/resetzone?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/savemxs":{"get":{"description":"This function creates a new MX record.\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"savemxs","parameters":[{"description":"The zone record's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The record name.","in":"query","name":"name","required":true,"schema":{"example":"mail.example.com","type":"string"}},{"description":"The domain's mail exchanger.","in":"query","name":"exchange","required":true,"schema":{"example":"mail.example.com","format":"domain","type":"string"}},{"description":"The MX record's priority order.\n\n**Note:**\n\nLower numbers indicate a higher priority order.","in":"query","name":"preference","required":true,"schema":{"example":20,"minimum":1,"type":"integer"}},{"description":"The record's class.","in":"query","name":"class","required":false,"schema":{"default":"IN","example":"IN","type":"string"}},{"description":"The record's Time To Live (TTL) in seconds.","in":"query","name":"ttl","required":false,"schema":{"default":14400,"example":14400,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"savemxs","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Bind reloading on server1 using rndc zone: [example.com]\n","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create mail exchanger record","tags":["DNS","Domain Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n savemxs \\\n domain='example.com' \\\n name='mail.example.com' \\\n exchange='mail.example.com' \\\n preference='20'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/savemxs?api.version=1&domain=example.com&name=mail.example.com&exchange=mail.example.com&preference=20"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.28"}},"/set_up_dns_resolver_workarounds":{"get":{"description":"This function creates an [Unbound](http://www.linuxfromscratch.org/blfs/view/svn/server/unbound.html) (`libunbound`) DNS resolver configuration.\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"set_up_dns_resolver_workarounds","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"flags":{"description":"An object that contains of [`libunbound` configuration options](https://www.nlnetlabs.nl/documentation/unbound/unbound.conf/).\n\n**Note:**\n\nThe function **only** returns an option if the system finds a configuration issue.","properties":{"do-ip6":{"description":"The system **cannot** create an [IPv6](https://en.wikipedia.org/wiki/IPv6) socket.","example":"no","type":"string"},"do-udp":{"description":"The system **cannot** receive a [User Datagram Protocol (UDP)](https://en.wikipedia.org/wiki/User_Datagram_Protocol) DNS response.","example":"no","type":"string"},"edns-buffer-size":{"description":"The [extension mechanism for DNS (EDNS)](https://en.wikipedia.org/wiki/Extension_mechanisms_for_DNS) length size is at or exceeds 512 bytes.","example":"512","type":"string"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_up_dns_resolver_workarounds","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create unbound DNS resolver","tags":["DNS","Resolvers"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_up_dns_resolver_workarounds\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_up_dns_resolver_workarounds?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"84"}},"/export_zone_dnskey":{"get":{"description":"This function exports a domain's DNSKEY record value.","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":{"data":{"properties":{"dnskey":{"description":"The DNSKEY record value.","example":"AwEAAch8SGW4vE6PjFWA9rbUm0AfTq+gJ0HC/nLu+2axdWHBIStt9lsOzKDorAr4vlmhlJzEzA62s96xp6mZ7XHUyWnkFwLs8obo6upL2in4h1ToOxzVl3lTs8O+kWtDq5/h1nwFlPDs9zpLJhlkTCtx2OTGbvimEYeqwPolUuSQR/Yb","type":"string"},"key_id":{"description":"The security key's ID.","example":12345,"minimum":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"export_zone_dnskey","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Export domain's DNSKEY record value","tags":["DNS","DNS Zones"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n export_zone_dnskey \\\n domain='example.com' \\\n key_id='12345'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/export_zone_dnskey?api.version=1&domain=example.com&key_id=12345"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"88"}},"/update_reverse_dns_cache":{"get":{"description":"This function queries DNS and updates the map of local IP addresses to reverse DNS names.","operationId":"update_reverse_dns_cache","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"update_reverse_dns_cache","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update reverse DNS cache","tags":["DNS","DNS Zones"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n update_reverse_dns_cache\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/update_reverse_dns_cache?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/set_nsec3_for_domains":{"get":{"description":"This function configures the domain to use [Next Secure Record 3](https://tools.ietf.org/html/rfc4470) (NSEC3) semantics.\n\n**Note:**\n\nOnly servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn't use PowerDNS, you will receive an error.","operationId":"set_nsec3_for_domains","parameters":[{"description":"The domain for which to enable NSEC3 semantics.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"Whether the system will create records for **all** delegations.\n* `1` - Create records for **all** delegations.\n* `0` - Create records **only** for secure delegations.\n\n**Note**\n\nOnly select `1` if you **must** create records for all delegations.","in":"query","name":"nsec3_opt_out","required":true,"schema":{"enum":[0,1],"example":0,"type":"integer"}},{"description":"The number of times that the system re-executes the first resource record hash operation.","in":"query","name":"nsec3_iterations","required":true,"schema":{"example":7,"maximum":500,"minimum":1,"type":"integer"}},{"description":"Whether NSEC3 will operate in Narrow mode or Inclusive mode.\n\n **Note**\n\nFor information about these modes, read [PowerDNS's DNSSEC documentation](https://doc.powerdns.com/authoritative/dnssec/intro.html).\n\n* `1` - Narrow mode.\n* `0` - Inclusive mode.","in":"query","name":"nsec3_narrow","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"The salt value that PowerDNS uses in the hashes.\n\n **Note:**\n\n For information about salt values, read [RFC 5155](https://tools.ietf.org/html/rfc5155#section-3.1.5).","in":"query","name":"nsec3_salt","required":true,"schema":{"example":"1a2b3c4d5e6f","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"domains":{"description":"An array of objects that contains information about each domain.","items":{"properties":{"domain":{"description":"The domain for which the system enabled NSEC3.","example":"example.com","format":"domain","type":"string"},"enabled":{"description":"Whether the system enabled NSEC3.\n- `1` — Enabled.\n- `0` — The system failed to enable NSEC3.","enum":[0,1],"example":1,"type":"integer"},"error":{"description":"An error message that describes why the system could not enable NSEC3.\n\n**Note:**\n\n The function **only** displays this return when the enabled return is a `0` value.","example":"Error message.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_nsec3_for_domains","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason `field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable NSEC3 semantics for domain","tags":["DNS","Domain Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_nsec3_for_domains \\\n domain='example.com' \\\n nsec3_opt_out='0' \\\n nsec3_iterations='7' \\\n nsec3_narrow='1' \\\n nsec3_salt='1a2b3c4d5e6f'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_nsec3_for_domains?api.version=1&domain=example.com&nsec3_opt_out=0&nsec3_iterations=7&nsec3_narrow=1&nsec3_salt=1a2b3c4d5e6f"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/unset_nsec3_for_domains":{"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](https://tools.ietf.org/html/rfc4470) (NSEC3) semantics.\n\n**Note:**\n\nOnly servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn't use PowerDNS, you will receive an error.","operationId":"unset_nsec3_for_domains","parameters":[{"description":"The domain for 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":{"data":{"properties":{"domains":{"description":"An array of objects that contain information about each domain.","items":{"properties":{"disabled":{"description":"Whether the system disabled NSEC3.\n* `1` — Disabled.\n* `0` — The system failed to disable NSEC3.","enum":[0,1],"example":1,"type":"integer"},"domain":{"description":"The domain for which to disable NSEC3.","example":"example.com","type":"string"},"error":{"description":"An error message that describes why the system could not disable NSEC3.\n\n**Note:**\n\nThe function **only** displays this return when the `disabled` return is a `0` value.","example":"Error message.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"unset_nsec3_for_domains","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable NSEC semantics for domain","tags":["DNS","Domain Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n unset_nsec3_for_domains \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/unset_nsec3_for_domains?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"86"}},"/get_disk_usage":{"get":{"description":"This function lists the disk usage status of the system's user accounts. This also lists information about file system object (inode) usage.","operationId":"get_disk_usage","parameters":[{"description":"Each cPanel & WHM server maintains a cache of users’ disk quota\nusage. This parameter controls the way this function will use\nthat cache.\n\n* `on` - Use the quota cache. This is fast, but it may be inaccurate.\n* `off` - Ignore the quota cache. This is slower, but it will be more accurate.","in":"query","name":"cache_mode","required":false,"schema":{"default":"on","enum":["on","off"],"example":"on","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"accounts":{"description":"A list of objects containing the disk usage data for all accounts on the server.","items":{"properties":{"blocks_limit":{"description":"The account's disk space quota, in kibibytes (KiB).\n* `null` - The account has unlimited disk space.","example":null,"minimum":0,"nullable":true,"type":"integer"},"blocks_used":{"description":"The account's current disk space usage, in kibibytes (KiB).","example":2632,"minimum":0,"type":"integer"},"inodes_limit":{"description":"The account's inode quota.\n* `null` - The account has an unlimited number of inodes.","example":9999,"minimum":0,"nullable":true,"type":"integer"},"inodes_used":{"description":"The account's current inode usage.","example":340,"minimum":0,"type":"integer"},"user":{"description":"The cPanel or Reseller account username.","example":"username","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_disk_usage","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all cPanel accounts disk usage","tags":["Bandwidth and Disk Quotas"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_disk_usage\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_disk_usage?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"80"}},"/get_available_applications":{"get":{"description":"This function returns the contents of a `dynamicui` file. For more\ninformation, read our\n[Guide to WHM dynamicui Files](https://go.cpanel.net/GuidetoWHMdynamicuiFiles)\ndocumentation.","operationId":"get_available_applications","parameters":[{"description":"The `dynamicui` configuration file to retrieve, relative to the `/usr/local/cpanel/whostmgr/docroot/themes/x/` directory.","in":"query","name":"file","required":false,"schema":{"default":"dynamicui.conf","example":"dynamicui.conf","type":"string"}},{"description":"A comma-separated list of the application entries to return.\n\nTo determine the application's name, find its\n[`file` value in the `dynamicui.conf` file](https://go.cpanel.net/GuidetoWHMdynamicuiFiles),\nand then remove the file extension.\n\nIf you do not specify this value, the function returns the entire `dynamicui.conf`\nfile.","in":"query","name":"applications_list","required":false,"schema":{"example":"create_support_ticket","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"groups":{"description":"An array of objects containing the file's contents.","items":{"$ref":"#/components/schemas/Group"}},"raw":{"description":"An array of objects containing the file's raw data for template directives.","items":{"$ref":"#/components/schemas/Raw"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_available_applications","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return dynamicui file","tags":["Packages","Feature Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_available_applications\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_available_applications?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"76"}},"/accept_eula":{"get":{"description":"This function records acceptance of cPanel & WHM's legal terms. To do this, the function creates a touchfile in the `/var/cpanel/activate/` directory.\n\n**Important:**\n\n Server owners *must* accept these agreements before they use cPanel & WHM.","operationId":"accept_eula","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"accept_eula","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result`\nfield is `0`. This field may display a success message when\na function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Save EULA acceptance","tags":["Updates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n accept_eula\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/accept_eula?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"76"}},"/ea4_get_currently_installed_packages":{"get":{"description":"This function returns a list of the currently-installed EasyApache 4 packages.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"ea4_get_currently_installed_packages","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"packages":{"description":"A list of the currently installed packages.","items":{"example":"ea-apache24","type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"ea4_get_currently_installed_packages","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return installed Easyapache 4 packages","tags":["EasyApache","EasyApache Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n ea4_get_currently_installed_packages\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ea4_get_currently_installed_packages?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"62"}},"/ea4_metainfo":{"get":{"description":"This function returns the contents of the `/etc/cpanel/ea4/ea4-metainfo.json` file.","operationId":"ea4_metainfo","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"additionalProperties":{"description":"Returns the contents of the `/etc/cpanel/ea4/ea4-metainfo.json` file.\nReturns an empty value if the `/etc/cpanel/ea4/ea4-metainfo.json` file does not exist.","type":"object"},"description":"Contents of the `/etc/cpanel/ea4/ea4-metainfo.json` file.","example":{"additional_packages":["ea-nginx","ea-example"],"default_php_handler":"cgi","default_php_package":"ea-php72","type":"object"}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"ea4_metainfo","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return ea4-metainfo.json file contents","tags":["EasyApache","EasyApache Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n ea4_metainfo\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ea4_metainfo?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"80"}},"/ea4_recommendations":{"get":{"description":"This function returns any recommendations attached to your installed\nEasyApache 4 packages. For more information about the recommendation system,\nread our [EasyApache 4 Recommendations](https://go.cpanel.net/EasyApache4Recommendations) documentation.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"ea4_recommendations","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"additionalProperties":{"description":"* An object that contains recommendation information about a package.\n\n**Note:**\n\n* The function uses the name of the referenced package as the return name. For example, `ea-php74-php`.","items":{"properties":{"desc":{"description":"The recommendation's description.\n\n**Note:**\n\n* The function **only** returns this value if it exists.","type":"string"},"level":{"description":"The level that triggers a recommendation to appear, based on [Bootstrap 3 alert components](http://getbootstrap.com/components/#alerts).\n\n* `primary`\n* `success`\n* `info`\n* `warning`\n* `danger`\n\n**Note:**\n\n* The function **only** returns this value if it exists.\n* This return's value only affects the UI if set to `danger`.","enum":["primary","success","info","warning","danger"],"type":"string"},"name":{"description":"The recommendation's name.","type":"string"},"on":{"description":"The action that triggers a recommendation.\n\n* `add`\n* `remove`","enum":["add","remove"],"type":"string"},"options":{"description":"An object that contains each option for the package's recommendations.","items":{"properties":{"items":{"description":"An array of information that corresponds with a text value.\n\n**Note:**\n\nThe function **only** returns this value if it exists.","example":["ea-apache24"],"items":{"type":"string"},"type":"array"},"level":{"description":"The level that triggers a recommendation to appear, based on [Bootstrap 3 alert components](http://getbootstrap.com/components/#alerts).\n\n* `primary`\n* `success`\n* `info`\n* `warning`\n* `danger`\n\n**Note:**\n\n* The function **only** returns this value if it exists.\n* This return's value only affects the UI if set to `danger`.","enum":["primary","success","info","warning","danger"],"type":"string"},"recommended":{"description":"The type of recommendation that the interface will return.\n\n* `true` - Recommended.\n* `false` - Not recommended.\n\n**Note:**\n\n* The function **only** returns this value if it exists.\n* If the function does **not** return this value, then the text displayed in the interface is informational.","enum":[true,false],"type":"boolean"},"text":{"description":"The text returned in the user interface.","type":"string"},"url":{"description":"A URL that provides more information.\n\n**Note:**\n\nThe function **only** returns this value if it exists.","format":"url","type":"string"}},"type":"object"},"type":"array"},"url":{"description":"A URL to provide more information.\n\n**Note:**\n\n* The function **only** returns this value if it exists.","format":"url","type":"string"}},"type":"object"},"type":"array"},"example":{"ea-php55-php":[{"desc":"PHP DSO runs as the user by default. In a shared hosting environment, this is a security issue.","level":"danger","name":"PHP DSO","on":"add","options":[{"items":["ruid2","mpm-itk"],"level":"success","recommended":true,"text":"We strongly recommend that you install one of the following packages unless this is a single-user system:"},{"level":"warning","recommended":false,"text":"If you use suPHP, you will add some security, but may experience performance issues on your server."}],"url":"https://www.example.com"}]},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"ea4_recommendations","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"- 1 - Success.\n- 0 - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return EasyApache 4 recommendations","tags":["EasyApache","EasyApache Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n ea4_recommendations\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ea4_recommendations?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"64"}},"/getzonerecord":{"get":{"description":"This function returns a line from a domain's DNS zone configuration.\n\n**Note:**\n\nOn servers that run CentOS 7, you may see a named warning about the absence of SPF resource records on DNS.\n * This warning is **not** relevant on CentOS 7 servers, because [RFC 7208 deprecated SPF records](https://tools.ietf.org/html/rfc7208). CentOS 7 servers use TXT records instead of SPF records.\n * Red Hat 7.1 and CentOS 7.1 both contain `bind-9.9.4-23.el7`, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the [Red Hat Bugzilla case about SPF record errors](https://bugzilla.redhat.com/show_bug.cgi?id=1215164).\n\n**Important:**\n\n When you disable the [DNS Role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"getzonerecord","parameters":[{"description":"The zone record's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","type":"string"}},{"description":"The zone record's line number.","in":"query","name":"line","required":true,"schema":{"example":2,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"record":{"description":"An array of objects containing the domain's zone record data.","items":{"$ref":"#/components/schemas/getzonerecordResponseBase"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"getzonerecord","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Record obtained.","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return specific line from domain's DNS configuration","tags":["DNS","DNS Zones"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n getzonerecord \\\n domain='example.com' \\\n line='2'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/getzonerecord?api.version=1&domain=example.com&line=2"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/addzonerecord":{"post":{"description":"This function adds a DNS zone record.\n\n**Important:**\n\n* When you call this function, you **must** include the additional parameters for the selected zone record type.\n* When you disable the [DNS role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.\n\n**Note:**\n\nOn servers that run CentOS 7, you may see a `named` warning about the absence of SPF resource records on DNS.\n * This warning is **not** relevant on CentOS 7 servers, because [RFC 7208 deprecated SPF records](https://tools.ietf.org/html/rfc7208). CentOS 7 servers use TXT records instead of SPF records.\n * Red Hat 7.1 and CentOS 7.1 both contain `bind-9.9.4-23.el7`, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the [Red Hat Bugzilla case about SPF record errors](https://bugzilla.redhat.com/show_bug.cgi?id=1215164).","operationId":"addzonerecord","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DnsAddZoneParameterType"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"addzonerecord","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Bind reloading on hostname using rndc zone: [example.com]\n","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create DNS zone record","tags":["DNS","Domain Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --input=json --output=jsonpretty \\\n addzonerecord\n"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/json-api/addzonerecord HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 0\n\n"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/remove_override_features_for_user":{"get":{"description":"This function removes feature overrides from a cPanel account.","operationId":"remove_override_features_for_user","parameters":[{"description":"The user's username.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"content":{"application/json":{"schema":{"example":["sslinstall","videotut"],"items":{"type":"string"},"type":"array"}}},"description":"An array that contains the features' names.\n\n**Note:**\n\n* Call WHM API 1's `get_feature_names` function to view available features.","in":"query","name":"features","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"remove_override_features_for_user","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove cPanel account feature list overrides","tags":["Packages","Feature Access"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n remove_override_features_for_user \\\n user='username' \\\n features='[\"sslinstall\",\"videotut\"]'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remove_override_features_for_user?api.version=1&user=username&features=%5b%22sslinstall%22%2c%22videotut%22%5d"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/ea4_save_profile":{"get":{"description":"This function creates an EasyApache 4 profile. This function only writes files to the `/etc/cpanel/ea4/profiles/custom/` directory.\n\n**Important**:\n\n When you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"ea4_save_profile","parameters":[{"description":"The profile's file name.","in":"query","name":"filename","required":true,"schema":{"example":"new_profile.json","type":"string"}},{"description":"The profile's display name.","in":"query","name":"name","required":true,"schema":{"example":"New Profile","type":"string"}},{"description":"The packages that the profile contains.","explode":true,"in":"query","name":"pkg","required":true,"schema":{"example":["ea-apache24","ea-apache24-foo"],"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"The description of the profile.","in":"query","name":"desc","required":false,"schema":{"default":"","example":"This is my new profile.","type":"string"}},{"description":"The profile's version number.","in":"query","name":"version","required":false,"schema":{"default":"0","example":"1.3","type":"string"}},{"description":"Tags that are appropriate for the profile.","explode":true,"in":"query","name":"tag","required":false,"schema":{"default":[],"example":["Apache 2.4","Optimized for static content"],"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Whether to overwrite the file, if it exists.\n\n* `1` — Overwrite the file.\n* `0` — Do **not** overwrite the file.","in":"query","name":"overwrite","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"already_exists":{"description":"Whether the filename value already exists.\n\n**Note**:\n\n The function only returns this field if the `overwrite` value is `0`, and the specified `filename` value already exists.\n- `1` — Exists.\n- `0` — Does **not** exist.","enum":[0,1],"example":1,"type":"integer"},"path":{"description":"The new profile's path.\n\n**Note**:\n\n The function only returns this field if it succeeds.","example":"/etc/cpanel/ea4/profiles/custom/new_profile.json","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"ea4_save_profile","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create EasyApache 4 profile","tags":["EasyApache","EasyApache Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n ea4_save_profile \\\n filename='new_profile.json' \\\n name='New Profile' \\\n pkg='ea-apache24' pkg='ea-apache24-foo'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ea4_save_profile?api.version=1&filename=new_profile.json&name=New%20Profile&pkg=ea-apache24&pkg=ea-apache24-foo"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"64"}},"/untrack_acct_id":{"get":{"description":"This function removes a user identification number (UID) or group\nidentification number (GID) from the tracked ID list.","operationId":"untrack_acct_id","parameters":[{"description":"The user or group ID to remove from the track list.\n\n**Note:**\n\n You **must** include the `uid` parameter, the `gid` parameter, or both.","in":"query","name":"uid or gid","required":true,"schema":{"example":1012,"type":"integer"}},{"description":"Whether to prevent removal of system user or group IDs.\n\n* `1` — Prevent removal.\n* `0` — Do **not** prevent removal.","in":"query","name":"protect_system","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to prevent removal of user or group IDs currently in use.\n\n* `1` — Prevent removal.\n* `0` — Do **not** prevent removal.","in":"query","name":"check_exists","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to prevent removal of the user ID if the quota system tracks associated files.\n\n* `1` — Prevent removal.\n* `0` — Do **not** prevent removal.\n\n**Note:**\n\n* This parameter **only** applies to user IDs and **not** group IDs.\n* You cannot check filesystems if the quota system does **not** track them.","in":"query","name":"check_quota","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"untrack_acct_id","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove UID or GID from tracked list","tags":["Accounts","Account Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n untrack_acct_id \\\n uid or gid='1012'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/untrack_acct_id?api.version=1&uid%20or%20gid=1012"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/generate_mobileconfig":{"get":{"description":"This function generates a mobile configuration profile 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":"generate_mobileconfig","parameters":[{"description":"The email account's username.","in":"query","name":"account","required":true,"schema":{"example":"username","type":"string"}},{"description":"Whether to use an SSL-encrypted connection.\n* `1` — Use an SSL-encrypted connnection.\n* `0` — Do **not** use an SSL-encrypted connection.","in":"query","name":"use_ssl","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"A comma-separated list of the email account service's `.mobileconfig` file names.\n* `caldav` — The `.mobileconfig` file for calendar setup.\n* `carddav` — The `.mobileconfig` file for contacts setup.\n* `email` — The `.mobileconfig` file for email setup.\n\n**Note:**\n\n * If you don't specify a value, this parameter uses the default values.\n * You can request one, two, or all possible values.\n * The function ignores unsupported values.","in":"query","name":"selected_account_services","required":false,"schema":{"default":"email,caldav,carddav","enum":["caldav","carddav","email"],"example":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"The function's raw output. This function returns this value as a binary of an Apple mobile configuration file containing a series of sub-tags and keys. For more information, read [Apple's key reference](https://developer.apple.com/business/documentation/Configuration-Profile-Reference.pdf).","example":"MIIcIwYJKoZIhvcNAQcCoIIcFDCCHBACAQExDzANBglghkgBZQMEAgEFADCCFS4GCSqGSIb3DQEH\nAaCCFR8EghUbPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjwhRE9DVFlQ\nRSBwbGlzdCBQVUJMSUMgIi0vL0FwcGxlLy9EVEQgUExJU1QgMS4wLy9FTiIgImh0dHA6Ly93d3cu\nYXBwbGUuY29tL0RURHMvUHJvcGVydHlMaXN0LTEuMC5kdGQiPg0KPHBsaXN0IHZlcnNpb249IjEu\nMCI+DQo8ZGljdD4NCiAgPGtleT5QYXlsb2FkQ29udGVudDwva2V5Pg0KICA8YXJyYXk+DQogICAg\nPGRpY3Q+DQogICAgICAgIDxrZXk+Q2FsREFWQWNjb3VudERlc2NyaXB0aW9uPC9rZXk+DQogICAg\nICAgIDxzdHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDwvc3Ry\naW5nPg0KICAgICAgICA8a2V5PkNhbERBVkhvc3ROYW1lPC9rZXk+DQogICAgICAgIDxzdHJpbmc+\naG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDwvc3RyaW5nPg0KICAgICAgICA8a2V5PkNh\nbERBVlBvcnQ8L2tleT4NCiAgICAgICAgPGludGVnZXI+ODQ0MzwvaW50ZWdlcj4NCiAgICAgICAg\nPGtleT5DYWxEQVZQcmluY2lwYWxVUkw8L2tleT4NCiAgICAgICAgPHN0cmluZz4vcHJpbmNpcGFs\ncy9fX3VpZHNfXy8vPC9zdHJpbmc+DQogICAgICAgIDxrZXk+Q2FsREFWVXNlU1NMPC9rZXk+DQog\nICAgICAgIDx0cnVlLz4NCiAgICAgICAgPGtleT5DYWxEQVZVc2VybmFtZTwva2V5Pg0KICAgICAg\nICA8c3RyaW5nPnVzZXJuYW1lPC9zdHJpbmc+DQogICAgICAgIDxrZXk+UGF5bG9hZERlc2NyaXB0\naW9uPC9rZXk+DQogICAgICAgIDxzdHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYtMS0xMS5hc2hs\nZXk4MnNiLnRsZCBTZWN1cmUgQ2FsZW5kYXIgU2V0dXA8L3N0cmluZz4NCiAgICAgICAgPGtleT5Q\nYXlsb2FkRGlzcGxheU5hbWU8L2tleT4NCiAgICAgICAgPHN0cmluZz51c2VybmFtZUBob3N0LTE3\nMi0xNi0xLTExLmFzaGxleTgyc2IudGxkIFNlY3VyZSBDYWxlbmRhciBTZXR1cDwvc3RyaW5nPg0K\nICAgICAgICA8a2V5PlBheWxvYWRJZGVudGlmaWVyPC9rZXk+DQogICAgICAgIDxzdHJpbmc+Y3Bh\nbmVsLm1haWwub3JnLnVzZXJuYW1lLmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQ8L3N0\ncmluZz4NCiAgICAgICAgPGtleT5QYXlsb2FkT3JnYW5pemF0aW9uPC9rZXk+DQogICAgICAgIDxz\ndHJpbmc+aG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDwvc3RyaW5nPg0KICAgICAgICA8\na2V5PlBheWxvYWRUeXBlPC9rZXk+DQogICAgICAgIDxzdHJpbmc+Y29tLmFwcGxlLmNhbGRhdi5h\nY2NvdW50PC9zdHJpbmc+DQogICAgICAgIDxrZXk+UGF5bG9hZFVVSUQ8L2tleT4NCiAgICAgICAg\nPHN0cmluZz4wNWQ3OTBjMS03MjVlLTIxODUtMDM1YS0yODNiZGJkMDUxMWQ8L3N0cmluZz4NCiAg\nICAgICAgPGtleT5QYXlsb2FkVmVyc2lvbjwva2V5Pg0KICAgICAgICA8aW50ZWdlcj4xPC9pbnRl\nZ2VyPg0KICAgIDwvZGljdD4NCiAgICA8ZGljdD4NCiAgICAgICAgPGtleT5DYXJkREFWQWNjb3Vu\ndERlc2NyaXB0aW9uPC9rZXk+DQogICAgICAgIDxzdHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYt\nMS0xMS5hc2hsZXk4MnNiLnRsZCBTZWN1cmUgQ29udGFjdHMgU2V0dXA8L3N0cmluZz4NCiAgICAg\nICAgPGtleT5DYXJkREFWSG9zdE5hbWU8L2tleT4NCiAgICAgICAgPHN0cmluZz5ob3N0LTE3Mi0x\nNi0xLTExLmFzaGxleTgyc2IudGxkOjg0NDM8L3N0cmluZz4NCiAgICAgICAgPGtleT5DYXJkREFW\nVXNlU1NMPC9rZXk+DQogICAgICAgIDx0cnVlLz4NCiAgICAgICAgPGtleT5DYXJkREFWVXNlcm5h\nbWU8L2tleT4NCiAgICAgICAgPHN0cmluZz51c2VybmFtZTwvc3RyaW5nPg0KICAgICAgICA8a2V5\nPlBheWxvYWREZXNjcmlwdGlvbjwva2V5Pg0KICAgICAgICA8c3RyaW5nPnVzZXJuYW1lQGhvc3Qt\nMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQgU2VjdXJlIENvbnRhY3RzIFNldHVwPC9zdHJpbmc+\nDQogICAgICAgIDxrZXk+UGF5bG9hZERpc3BsYXlOYW1lPC9rZXk+DQogICAgICAgIDxzdHJpbmc+\nQ2FyZERBVjwvc3RyaW5nPg0KICAgICAgICA8a2V5PlBheWxvYWRJZGVudGlmaWVyPC9rZXk+DQog\nICAgICAgIDxzdHJpbmc+Y3BhbmVsLm1haWwub3JnLnVzZXJuYW1lLmhvc3QtMTcyLTE2LTEtMTEu\nYXNobGV5ODJzYi50bGQ8L3N0cmluZz4NCiAgICAgICAgPGtleT5QYXlsb2FkT3JnYW5pemF0aW9u\nPC9rZXk+DQogICAgICAgIDxzdHJpbmc+aG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDwv\nc3RyaW5nPg0KICAgICAgICA8a2V5PlBheWxvYWRUeXBlPC9rZXk+DQogICAgICAgIDxzdHJpbmc+\nY29tLmFwcGxlLmNhcmRkYXYuYWNjb3VudDwvc3RyaW5nPg0KICAgICAgICA8a2V5PlBheWxvYWRV\nVUlEPC9rZXk+DQogICAgICAgIDxzdHJpbmc+Y2U0YTRiYjEtODQ3Yi1hYWQ0LWVkMTUtNzIyMDY2\nMzA5YzIyPC9zdHJpbmc+DQogICAgICAgIDxrZXk+UGF5bG9hZFZlcnNpb248L2tleT4NCiAgICAg\nICAgPGludGVnZXI+MTwvaW50ZWdlcj4NCiAgICA8L2RpY3Q+DQogICAgPGRpY3Q+DQogICAgICA8\na2V5PkVtYWlsQWNjb3VudERlc2NyaXB0aW9uPC9rZXk+DQogICAgICA8c3RyaW5nPnVzZXJuYW1l\nQGhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQ8L3N0cmluZz4NCiAgICAgIDxrZXk+RW1h\naWxBY2NvdW50TmFtZTwva2V5Pg0KICAgICAgPHN0cmluZz51c2VybmFtZUBob3N0LTE3Mi0xNi0x\nLTExLmFzaGxleTgyc2IudGxkPC9zdHJpbmc+DQogICAgICA8a2V5PkVtYWlsQWNjb3VudFR5cGU8\nL2tleT4NCiAgICAgIDxzdHJpbmc+RW1haWxUeXBlSU1BUDwvc3RyaW5nPg0KICAgICAgPGtleT5F\nbWFpbEFkZHJlc3M8L2tleT4NCiAgICAgIDxzdHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYtMS0x\nMS5hc2hsZXk4MnNiLnRsZDwvc3RyaW5nPg0KICAgICAgPGtleT5JbmNvbWluZ01haWxTZXJ2ZXJB\ndXRoZW50aWNhdGlvbjwva2V5Pg0KICAgICAgPHN0cmluZz5FbWFpbEF1dGhQYXNzd29yZDwvc3Ry\naW5nPg0KICAgICAgPGtleT5JbmNvbWluZ01haWxTZXJ2ZXJIb3N0TmFtZTwva2V5Pg0KICAgICAg\nPHN0cmluZz5ob3N0LTE3Mi0xNi0xLTExLmFzaGxleTgyc2IudGxkPC9zdHJpbmc+DQogICAgICA8\na2V5PkluY29taW5nTWFpbFNlcnZlclBvcnROdW1iZXI8L2tleT4NCiAgICAgIDxpbnRlZ2VyPjk5\nMzwvaW50ZWdlcj4NCiAgICAgIDxrZXk+SW5jb21pbmdNYWlsU2VydmVyVXNlU1NMPC9rZXk+DQog\nICAgICA8dHJ1ZS8+DQogICAgICA8a2V5PkluY29taW5nTWFpbFNlcnZlclVzZXJuYW1lPC9rZXk+\nDQogICAgICA8c3RyaW5nPnVzZXJuYW1lPC9zdHJpbmc+DQogICAgICA8a2V5Pk91dGdvaW5nTWFp\nbFNlcnZlckF1dGhlbnRpY2F0aW9uPC9rZXk+DQogICAgICA8c3RyaW5nPkVtYWlsQXV0aFBhc3N3\nb3JkPC9zdHJpbmc+DQogICAgICA8a2V5Pk91dGdvaW5nTWFpbFNlcnZlckhvc3ROYW1lPC9rZXk+\nDQogICAgICA8c3RyaW5nPmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQ8L3N0cmluZz4N\nCiAgICAgIDxrZXk+T3V0Z29pbmdNYWlsU2VydmVyUG9ydE51bWJlcjwva2V5Pg0KICAgICAgPGlu\ndGVnZXI+NDY1PC9pbnRlZ2VyPg0KICAgICAgPGtleT5PdXRnb2luZ01haWxTZXJ2ZXJVc2VTU0w8\nL2tleT4NCiAgICAgIDx0cnVlLz4NCiAgICAgIDxrZXk+T3V0Z29pbmdNYWlsU2VydmVyVXNlcm5h\nbWU8L2tleT4NCiAgICAgIDxzdHJpbmc+dXNlcm5hbWU8L3N0cmluZz4NCiAgICAgIDxrZXk+T3V0\nZ29pbmdQYXNzd29yZFNhbWVBc0luY29taW5nUGFzc3dvcmQ8L2tleT4NCiAgICAgIDx0cnVlLz4N\nCiAgICAgIDxrZXk+UGF5bG9hZERlc2NyaXB0aW9uPC9rZXk+DQogICAgICA8c3RyaW5nPnVzZXJu\nYW1lQGhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQgU2VjdXJlIEVtYWlsIFNldHVwPC9z\ndHJpbmc+DQogICAgICA8a2V5PlBheWxvYWREaXNwbGF5TmFtZTwva2V5Pg0KICAgICAgPHN0cmlu\nZz51c2VybmFtZUBob3N0LTE3Mi0xNi0xLTExLmFzaGxleTgyc2IudGxkIFNlY3VyZSBFbWFpbCBT\nZXR1cDwvc3RyaW5nPg0KICAgICAgPGtleT5QYXlsb2FkSWRlbnRpZmllcjwva2V5Pg0KICAgICAg\nPHN0cmluZz5jcGFuZWwubWFpbC5vcmcudXNlcm5hbWUuaG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4\nMnNiLnRsZDwvc3RyaW5nPg0KICAgICAgPGtleT5QYXlsb2FkT3JnYW5pemF0aW9uPC9rZXk+DQog\nICAgICA8c3RyaW5nPmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQ8L3N0cmluZz4NCiAg\nICAgIDxrZXk+UGF5bG9hZFR5cGU8L2tleT4NCiAgICAgIDxzdHJpbmc+Y29tLmFwcGxlLm1haWwu\nbWFuYWdlZDwvc3RyaW5nPg0KICAgICAgPGtleT5QYXlsb2FkVVVJRDwva2V5Pg0KICAgICAgPHN0\ncmluZz5hNmIzZTAxMC0wMGMxLWIyZjAtYWU4Mi03ZmIzZjllODkzM2Y8L3N0cmluZz4NCiAgICAg\nIDxrZXk+UGF5bG9hZFZlcnNpb248L2tleT4NCiAgICAgIDxpbnRlZ2VyPjE8L2ludGVnZXI+DQog\nICAgICA8a2V5PlByZXZlbnRBcHBTaGVldDwva2V5Pg0KICAgICAgPGZhbHNlLz4NCiAgICAgIDxr\nZXk+UHJldmVudE1vdmU8L2tleT4NCiAgICAgIDxmYWxzZS8+DQogICAgICA8a2V5PlNNSU1FRW5h\nYmxlZDwva2V5Pg0KICAgICAgPGZhbHNlLz4NCiAgICAgIDxrZXk+SW5jb21pbmdNYWlsU2VydmVy\nSU1BUFBhdGhQcmVmaXg8L2tleT4NCiAgICAgIDxzdHJpbmc+SU5CT1g8L3N0cmluZz4NCiAgICA8\nL2RpY3Q+DQogIDwvYXJyYXk+DQogIDxrZXk+UGF5bG9hZERlc2NyaXB0aW9uPC9rZXk+DQogIDxz\ndHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZCBTZWN1cmUgRW1h\naWwgU2V0dXA8L3N0cmluZz4NCiAgPGtleT5QYXlsb2FkRGlzcGxheU5hbWU8L2tleT4NCiAgPHN0\ncmluZz51c2VybmFtZUBob3N0LTE3Mi0xNi0xLTExLmFzaGxleTgyc2IudGxkIFNlY3VyZSBFbWFp\nbCBTZXR1cDwvc3RyaW5nPg0KICA8a2V5PlBheWxvYWRJZGVudGlmaWVyPC9rZXk+DQogIDxzdHJp\nbmc+Y3BhbmVsLm1haWwub3JnLnVzZXJuYW1lLmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50\nbGQtZW1haWw8L3N0cmluZz4NCiAgPGtleT5QYXlsb2FkT3JnYW5pemF0aW9uPC9rZXk+DQogIDxz\ndHJpbmc+Y3BhbmVsLm1haWwub3JnLnVzZXJuYW1lLmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJz\nYi50bGQ8L3N0cmluZz4NCiAgPGtleT5QYXlsb2FkUmVtb3ZhbERpc2FsbG93ZWQ8L2tleT4NCiAg\nPGZhbHNlLz4NCiAgPGtleT5QYXlsb2FkVHlwZTwva2V5Pg0KICA8c3RyaW5nPkNvbmZpZ3VyYXRp\nb248L3N0cmluZz4NCiAgPGtleT5QYXlsb2FkVVVJRDwva2V5Pg0KICA8c3RyaW5nPjRmMzI4YTVm\nLWIzMzctODZmZS03Zjk4LTVhOWMyNzFlNzY0MTwvc3RyaW5nPg0KICA8a2V5PlBheWxvYWRWZXJz\naW9uPC9rZXk+DQogIDxpbnRlZ2VyPjE8L2ludGVnZXI+DQo8L2RpY3Q+DQo8L3BsaXN0Pg0KoIIE\nSTCCBEUwggMtoAMCAQICBQG7jhEyMA0GCSqGSIb3DQEBCwUAMF4xMjAwBgkqhkiG9w0BCQEWI3Nz\nbEBob3N0LTE3Mi0xNi0xLTExLmFzaGxleTgyc2IudGxkMSgwJgYDVQQDDB9ob3N0LTE3Mi0xNi0x\nLTExLmFzaGxleTgyc2IudGxkMB4XDTE5MTExOTEzMDk1OFoXDTIwMTExODEzMDk1OFowXjEyMDAG\nCSqGSIb3DQEJARYjc3NsQGhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQxKDAmBgNVBAMM\nH2hvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQDLTf43fqQJu57fAyGSBD+B/Zc3zVri44KCz/Oi9NlHCtmxET12+mE0TFkWGhjX+tzO\nfom+6Hj5KnGwr8K7qZoXq8zmiKGGvhvg11Ta6I3SJQL7VzU+wTBPXkAl+bWLBqoswzefA7A7jBZE\nv0c8W+wUAosjvmotUtiyeRsNbThTVBht7LwmHyCaAvHfIFkXkS96O6qqx0iZRlXZvahDjw6kiKOB\ne/kDpwl0YxMc3dEx2WCQyIZimtYOxNxglKKZ7UAnuKdy2we3AfOzhq3yKyDXsNyNrQghEn1aB1Ny\nY+/bYZYA/Mhlhk1jjMowEGsjLfJr1Kx6JhtBWzBPfUIkb4q7AgMBAAGjggEIMIIBBDAdBgNVHQ4E\nFgQUlzHaKABlXF/4KWQ7ZrNQij5iE/4wCQYDVR0TBAIwADCBjAYDVR0jBIGEMIGBgBSXMdooAGVc\nX/gpZDtms1CKPmIT/qFipGAwXjEyMDAGCSqGSIb3DQEJARYjc3NsQGhvc3QtMTcyLTE2LTEtMTEu\nYXNobGV5ODJzYi50bGQxKDAmBgNVBAMMH2hvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGSC\nBQG7jhEyMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAqBgNVHREEIzAhgh9ob3N0LTE3\nMi0xNi0xLTExLmFzaGxleTgyc2IudGxkMA0GCSqGSIb3DQEBCwUAA4IBAQCft6fX2NB0Lg3IM7UU\nw7eltKjsZOX3sCX/UQpwYdB8PcafoQ2Ddpb7H+CeyxW5tPk+qLpapnUWoIJBRahAQ+Xn3YWrJDfC\nFriWIdJH0Rk2Gwhydf7XM+yVm2HYBsAzfZWkF5EAjBJpgLN/28kAWdCv1p362nq79A/jrdKgpZdj\nz6fVb4aNMepJCcwIHivy7HN/PwmbXjqedwAMYsj/XEqw7aJX7+hI3VjFwkQxEbpyObVhcBhh+itt\n1O7t/MMWzg7mmJBnyTt+IbblYYEQoWvZXJgSGWT4U55mWF5arpjL9+NjFsbzvXl6TLEMzbVbpvxH\ntidgoiEpyBgzKFJ9p8TNMYICeTCCAnUCAQEwZzBeMTIwMAYJKoZIhvcNAQkBFiNzc2xAaG9zdC0x\nNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDEoMCYGA1UEAwwfaG9zdC0xNzItMTYtMS0xMS5hc2hs\nZXk4MnNiLnRsZAIFAbuOETIwDQYJYIZIAWUDBAIBBQCggeQwGAYJKoZIhvcNAQkDMQsGCSqGSIb3\nDQEHATAcBgkqhkiG9w0BCQUxDxcNMjAwODE0MjAwMjAwWjAvBgkqhkiG9w0BCQQxIgQguoXcvM7S\nh+TCpzAkazdEcoVI9NI91whPFvfJHZd9x4oweQYJKoZIhvcNAQkPMWwwajALBglghkgBZQMEASow\nCwYJYIZIAWUDBAEWMAsGCWCGSAFlAwQBAjAKBggqhkiG9w0DBzAOBggqhkiG9w0DAgICAIAwDQYI\nKoZIhvcNAwICAUAwBwYFKw4DAgcwDQYIKoZIhvcNAwICASgwDQYJKoZIhvcNAQEBBQAEggEACr8R\nPbw5CymW4Eep61SNsQzH54LXWbaS68mxF+Z8roOSLZTVYhBKP14bGJcUMhsS7c8zGYlOdwXWTA87\n4VQ0O4WIoWOsydxLVgHJ52ZDstN2iXsuW56Cm/Mk7Zow1MFdCJJ/ZX/oKOpnzm/t38kSvTXYyT/X\nLxGnTUYt+QbgUrqrxYZMbZeaAvGXkFTjTSi1kklZdnd7ndvashv5OhQ6zf6y831/c2M7mrn8vJKv\ne44Inb5NRBoK0MAc3f0vmAXrF087ayyNy6E1DqpdPWAGpCKYfIzWtIccrxKcguoIM4mWZ/Lp6mrZ\nI/2K6npCz9Wlm7iYASSsP3NMO8JWk7EWPA==\n","format":"base64","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"generate_mobileconfig","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create email account mobile profile configuration","tags":["Mail","Mail Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n generate_mobileconfig \\\n account='username' \\\n use_ssl='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/generate_mobileconfig?api.version=1&account=username&use_ssl=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/list_pops_for":{"get":{"description":"This function lists a cPanel account’s email accounts. To prevent falsified data or symlink exploitation, the function uses the specified cPanel account user, rather than `root` user, to read data from the user’s home directory. The system compares the collected data from the user’s home directory to a server-wide domains list. The comparison of the data validates whether you can trust the data.\n\n**Important:**\n\n When you disable the [Receive Mail role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"list_pops_for","parameters":[{"description":"The cPanel account user for which to list all owned email accounts.","in":"query","name":"user","required":true,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"pops":{"description":"An array of email accounts that the cPanel user owns.","items":{"example":"example1@example.com","format":"email","type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_pops_for","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's email accounts","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_pops_for \\\n user='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_pops_for?api.version=1&user=example"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.50"}},"/get_user_email_forward_destination":{"get":{"description":"This function retrieves the destination to which the system forwards a system account's email.\n\n**Note:**\n\n* Usually, the system sends notices about the server's problems and activity to the `root` account.\n* If you do **not** use the `suexec` module, the `nobody` user receives bounce messages from email that CGI scripts send.\n\n**Important:**\n\nWhen you disable the [Receive Mail](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles) role, the system **disables** this function.","operationId":"get_user_email_forward_destination","parameters":[{"description":"The system account name.","in":"query","name":"user","required":true,"schema":{"example":"root","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"forward_to":{"description":"The system accounts or email addresses to which the system forwards the account's email.","items":{"example":"user@example.com","type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_user_email_forward_destination","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account forward destination","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_user_email_forward_destination \\\n user='root'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_user_email_forward_destination?api.version=1&user=root"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/set_user_email_forward_destination":{"get":{"description":"This function sets the destination to which the system forwards a system account's email.\n\n**Notes:**\n\n* Usually, the system sends notices about the server's problems and activity to the `root` account.\n* If you do **not** use the `suexec` module, the `nobody` user receives bounce messages from email that CGI scripts send.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"set_user_email_forward_destination","parameters":[{"description":"The system account name to forward.","in":"query","name":"user","required":true,"schema":{"example":"root","type":"string"}},{"description":"The system account name or email address to which you wish to forward email.\n\n**Note:**\n\nTo forward messages to multiple accounts or email addresses, use a comma-separated list.","in":"query","name":"forward_to","required":true,"schema":{"example":"user","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_user_email_forward_destination","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update cPanel account email forward destination","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_user_email_forward_destination \\\n user='root' \\\n forward_to='user'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_user_email_forward_destination?api.version=1&user=root&forward_to=user"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/normalize_user_email_configuration":{"get":{"description":"This function fixes a user's misconfigured email settings. This includes any misconfigured email file and directory ownership and permissions.","operationId":"normalize_user_email_configuration","parameters":[{"description":"The cPanel account's username.","in":"query","name":"username","required":true,"schema":{"example":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"normalize_user_email_configuration","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Repair misconfigured email settings","tags":["Mail","Mail Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n normalize_user_email_configuration \\\n username='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/normalize_user_email_configuration?api.version=1&username=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"88"}},"/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\n To remove multiple domain DKIM records, duplicate the parameter name. For example, use the `domain=example-1.com`, `domain=example-2.com`, and `domain=example-3.com` parameters.","examples":{"multiple":{"summary":"To remove multiple domain DKIM records","value":"domain=example-1.com domain=example-2.com domain=example-3.com"},"single":{"summary":"To remove a single domain DKIM record","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects that contains 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","type":"string"},"msg":{"description":"Information about the removed DKIM record.","example":"[REMOVE:TXT@default._domainkey:v=DKIM1; k=rsa; p=MIGfMAOGCSqGSIb3DQEBAQUAA4GNADCBiLMNOpQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO/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"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"disable_dkim","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable domain's DKIM records","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n disable_dkim \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/disable_dkim?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"78"}},"/enable_dkim":{"get":{"description":"This function enables DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains.","operationId":"enable_dkim","parameters":[{"description":"The domain for which to enable DKIM records on the DNS server.\n\n**Note:**\n\n To enable multiple domain DKIM records, duplicate the parameter name. For example, use the `domain=example-1.com`, `domain=example-2.com`, and `domain=example-3.com parameters`.","examples":{"multiple":{"summary":"To enable multiple domain DKIM records","value":"domain=example-1.com domain=example-2.com domain=example-3.com"},"single":{"summary":"To enable a single domain DKIM record","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects containing 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":"Installed Keys","type":"string"},"status":{"description":"Whether the system enabled the domain's DKIM record on the DNS server.\n* `1` — The system enabled the domain's DKIM record.\n* `0` — The system did **not** enable the domain's DKIM record.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"enable_dkim","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable domain's DKIM records","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n enable_dkim \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/enable_dkim?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"78"}},"/fetch_dkim_private_keys":{"get":{"description":"This function returns a domain's installed DKIM private key in [Privacy-Enhanced Mail](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) (PEM) format.\n\n**Warning:**\n\n We **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 queried domain.\n\n**Note:**\n\n To retrieve multiple domain DKIM keys, increment the parameter name. For example, use the `domain-1=example-1.com`, `domain-2=example-2.com`, and `domain-3=example-3.com` parameters.","examples":{"multiple":{"summary":"Query multiple domains.","value":"domain=example-1.com&domain=example-2.com&domain=example-3.com"},"single":{"summary":"Query a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array containing information about the domain's DKIM private key.","items":{"properties":{"domain":{"description":"The queried domain.","example":"example.com","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","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"fetch_dkim_private_keys","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domain's DKIM private key","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n fetch_dkim_private_keys \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_dkim_private_keys?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"78"}},"/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**Note:**\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\nTo check the DKIM key validity for multiple domain, duplicate the parameter name. For example, use the `domain-1=example.com`, `domain-2=example2.com`, and `domain-3=example3.com` parameters.","examples":{"multiple":{"summary":"Check the DKIM key validity for multiple domains.","value":"domain=example1.com&domain=example2.com&domain=example3.com"},"single":{"summary":"Check the DKIM key validity for a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects containing 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"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"ensure_dkim_keys_exist","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed: Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate domain's DKIM keys","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n ensure_dkim_keys_exist \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ensure_dkim_keys_exist?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"78"}},"/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, increment the parameter name. For example, use the `domain-1=example-1.com`, `domain-2=example-2.com`, and `domain-3=example3.com` parameters.","examples":{"multiple":{"summary":"Multiple domains","value":"domain-1=example-1.com&domain-2=example-2.com&domain-3=example-3.com"},"single":{"summary":"Single domain","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"An SPF record.\n\nYou **must** provide this parameter for every `domain` parameter.","in":"query","name":"record","required":true,"schema":{"example":"v%3Dspf1%20%2Bip4%3A1192.0.2.0%20-all","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects containing 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":"[REPLACE:TXT@example.com.:v=spf1 ip4:192.0.2.0 -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"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"install_spf_records","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Install domain SPF record","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n install_spf_records \\\n domain='example.com' \\\n record='v%3Dspf1%20%2Bip4%3A1192.0.2.0%20-all'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/install_spf_records?api.version=1&domain=example.com&record=v%253Dspf1%2520%252Bip4%253A1192.0.2.0%2520-all"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"78"}},"/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**Notes:**\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 WHM API 1 `enable_dkim` function to update the local DNS server's DNS records.\n* We recommend that you use the WHM API 1 `install_dkim_private_keys` and `enable_dkim` functions in a batch WHM API 1 call.","operationId":"install_dkim_private_keys","parameters":[{"description":"The domain for which to install an RSA private key to the local server's DKIM record.\n\n**Note:**\n\nTo install RSA private keys for multiple domains, increment the parameter name. For example, use the `domain-1=example-1.com`, `domain-2=example-2.com`, and `domain-3=example-3.com` parameters.","examples":{"multiple":{"summary":"The domains for which to install an RSA private key to the local server's DKIM record.","value":"domain-1=example-1.com&domain-2=example-2.com&domain-3=example-3.com"},"single":{"summary":"The domain for which to install an RSA private key to the local server's DKIM record.","value":"example.com"}},"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\n * You **must** provide this parameter for each `domain` parameter.\n * To install multiple RSA keys for a domain, increment the parameter name. For example, use the `key-1`, `key-2` parameters.\nexamples:\n single:\n summary: An RSA key in [Privacy-Enhanced Mail (PEM)](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.\n value: key\n multiple:\n summary: RSA keys in [Privacy-Enhanced Mail (PEM)](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.\n value: key-1=KEYKEYKEY&key-2=KEYKEYKEY","in":"query","name":"key","required":true,"schema":{"example":"AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects containing information about the RSA private key installation to the local server's DKIM record.","items":{"properties":{"domain":{"description":"The RSA private key's associated domain.","example":"example.com","format":"domain","type":"string"},"msg":{"description":"The RSA private key's installation status message.","example":"Installed Keys","type":"string"},"status":{"description":"Whether the system installed the RSA private key to the local server's DKIM record.\n* `1` — The system installed the RSA private key.\n* `0` — The system **cannot** install the RSA private key.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"install_dkim_private_keys","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Install existing private key to DKIM record","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n install_dkim_private_keys \\\n domain='example.com' \\\n key='AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/install_dkim_private_keys?api.version=1&domain=example.com&key=AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm%2fPS%2b9BhZg%2bBqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"78"}},"/validate_current_dkims":{"get":{"description":"This function retrieves and checks the DomainKeys Identified Mail (DKIM) records for one or more domains.","operationId":"validate_current_dkims","parameters":[{"description":"The domain for which to check the DKIM records.\n\n**Note:**\n\nTo check multiple domains, duplicate or increment the parameter name.\nFor example, `domain-1`, `domain-2`, and `domain-3` parameters.","examples":{"multiple":{"summary":"Check the DKIM records for multiple domains.","value":"domain-1=example.com&domain-2=example.com&domain-3=example3.com"},"multiple-alternative":{"summary":"Check the DKIM records for multiple domains.","value":"domain=example.com&domain=example2.com&domain=example3.com"},"single":{"summary":"Check the DKIM records for a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects containing information about the domain's DKIM records.","example":[{"domain":"default._domainkey.example.com","expected":"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO/xJtrPZKskZF8/sU0zWGTqKUOErlyJfoJzMDUv3/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB\\","records":[{"current":"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO/xJtrPZKskZF8/sU0zWGTqKUOErlyJfoJzMDUv3/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB\\","state":"VALID"}],"state":"VALID","validity_cache_update":"valid"},{"domain":"default._domainkey.example2.com","error":"(XID 4krw35) DNS returned “SERVFAIL” (code 2) in response to the system’s query for “default._domainkey.example2.com”’s “TXT” records.","expected":"v=DKIM1; k=rsa; p=MIIBIjAAAgkrhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4mA8NH3BkYvOmB0+ll23U78JesahG8304unKhW+MAm0ZE+i6EWN6iXhUj7FRPvI/6jFRd7qAHCPKFLo5+/PTy8C8eK312tfSnF3N0eucYFbgZ8F8iSRdgrcgEjvJ1vM1uvcUF211yd/e3jxT2Ge4/fmZcTYNjfH3uAuriv61L6pdIwHUWPhcjQvgOQoKQgXgooCUbUkWFDkMAH+EF/0g1dnXf289LjlvQsKhY7Y135Zpvm21kjUcj5mrLDlHJALzCVb8K/r/LCxjV5GFUyJiiNLAxkI9V1vZ4pMQvKIsN7wzu6gXK87w6mEWvKvipMAP8A2choDrk6H/fcQtfNodgwIDADAB;","records":[],"state":"ERROR","validity_cache_update":"none"}],"items":{"properties":{"domain":{"description":"The domain that the function used to check the DKIM record with a `default._domainkey` prefix.","type":"string"},"error":{"description":"An error message that details the reason why the DNS lookup failed.\n\n**Note:**\n\nThe function **only** returns this value when the `state` return\nis the `ERROR` value.","type":"string"},"expected":{"description":"The DKIM record's contents.","type":"string"},"records":{"description":"The domain's DNS `DKIM TXT` records.","items":{"properties":{"current":{"description":"The full contents of the domain's `DKIM TXT` record data.","type":"string"},"state":{"description":"The DKIM TXT record's status.\n\n* `VALID` — The `DKIM TXT` record matches the local server's\npublic key.\n* `MISMATCH` — The `DKIM TXT` record does **not** match the\nlocal server's public key.\n* `PERMFAIL` — Multiple `DKIM TXT` records for the domain\nexist or a misconfigured `DKIM TXT` record exists.","enum":["VALID","MISMATCH","PERMFAIL"],"type":"string"}},"type":"object"},"type":"array"},"state":{"description":"The domain's DKIM record status.\n\n* `VALID` — The DKIM record is valid.\n* `MALFORMED` — A single DKIM record exists, but the record\ndoes **not** match the expected DKIM specifications.\n* `MISMATCH` — A DKIM record exists, but it does **not** match the\nexpected 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\nthe reason in the `error` return value.","enum":["VALID","MALFORMED","MISMATCH","MISSING","MULTIPLE","NOPUB","ERROR"],"type":"string"},"validity_cache_update":{"description":"The result of the DKIM record's validity cache update operation.\n\n* `set` — The domain is invalid but passed its validity check.\nThe validity check now passes the domain as valid.\n* `valid` — The domain is valid and passed its validity check.\nThere are no changes required.\n* `none` — The domain is invalid but the system will **not** take\nfurther action.\n* `error` — The domain's validity check operation failed.","enum":["set","valid","none","error"],"type":"string"}},"type":"object"}}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"validate_current_dkims","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate DKIM records","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n validate_current_dkims \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/validate_current_dkims?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"78"}},"/validate_current_spfs":{"get":{"description":"This function validates a Sender Policy Framework (SPF) record for one or more domains.","operationId":"validate_current_spfs","parameters":[{"description":"The domain for which to check the SPF records.","examples":{"multiple":{"summary":"Check multiple domains.","value":"domain-1=example.com domain-2=example2.com domain-3=example3.com"},"multiple-alternative":{"summary":"Check multiple domains.","value":"domain=example.com domain=example2.com domain=example3.com"},"single":{"summary":"Check a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects containing information about a domain's SPF records.","example":[{"domain":"example.com","expected":"ip6:0:0:0:0:0:ffff:c0a8:101","ip_address":"0:0:0:0:0:ffff:c0a8:101","ip_version":6,"records":[{"current":"v=spf1 ~all","reason":"example.com: Sender is not authorized by default to use 'example.com' in 'helo' identity (mechanism '-all' matched)","state":"FAIL"}],"state":"VALID"},{"domain":"example2.com","error":"(XID rm8h9f) DNS returned “SERVFAIL” (code 2) in response to the system’s query for “example2.com”’s “TXT” records.","ip_address":"198.252.32.45","ip_version":4,"records":[],"state":"ERROR"}],"items":{"properties":{"domain":{"description":"The queried domain.","format":"domain","type":"string"},"error":{"description":"An error message that details the reason why the DNS lookup failed.\n\n**Note:**\n\nThe function **only** returns this value when the `state` return is\nthe `ERROR` value.","type":"string"},"expected":{"description":"The SPF record for the domain in the DNS.","type":"string"},"ip_address":{"anyOf":[{"format":"ipv4","type":"string"},{"format":"ipv6","type":"string"}],"description":"The domain's IPv4 or IPv6 address."},"ip_version":{"description":"The IP address version.\n\n* `4` — IPv4.\n* `6` — IPv6.","enum":[4,6],"type":"integer"},"records":{"description":"The SPF records of the domain's DNS.","items":{"properties":{"current":{"description":"The SPF record's contents.","type":"string"},"reason":{"description":"The reason for the SPF record's status.","type":"string"},"state":{"description":"The SPF record's status.\n\n* `PASS` — The SPF record confirms that the `ip_address` value\nis a valid sender.\n* `NEUTRAL` — The current SPF record configuration does not\ndetermine the `ip_address` value's validity.\n* `FAIL` — The SPF record states that the `ip_address` value\nis **not** a valid sender.\n* `SOFTFAIL` — The SPF record states that the `ip_address` value\nis **not** a valid sender, but does not `FAIL` state it.\n* `TEMPERROR` — The SPF record check resulted in a failure. For\nexample, a network failure.\n* `PERMERROR` — The domain's SPF records are **incorrect** and\nrequire manual correction.\n\n**Note:**\n\nThese values correspond with\n[RFC 7208 section 2.6](https://tools.ietf.org/html/rfc7208#section-2.6).","enum":["PASS","NEUTRAL","FAIL","SOFTFAIL","TEMPERROR","PERMERROR"],"type":"string"}},"type":"object"},"type":"array"},"state":{"description":"The SPF record's status.\n\n* `VALID` — A single `SPF TXT` record exists in the domain's DNS\nwith the correct `ip_address` value or redirect mechanism.\n* `MISMATCHED` — An `SPF TXT` record exists for the domain that\ndoes **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 system returns the\nreason in the `error` return.","enum":["VALID","MISMATCHED","MULTIPLE","MISSING","ERROR"],"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"validate_current_spfs","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate domain SPF records","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n validate_current_spfs \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/validate_current_spfs?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"78"}},"/edit_hook":{"get":{"description":"This function edits a script hook.","operationId":"edit_hook","parameters":[{"description":"The script hook's ID.\n\n**Note:**\n\nTo retrieve a hook's ID, use the WHM API 1 `list_hooks` function.","in":"query","name":"id","required":true,"schema":{"example":"HzEpGvT6QGUYwxuX3hWB8AUq","type":"string"}},{"description":"The absolute file path to the script that runs after the hook script to check the results.","in":"query","name":"check","required":false,"schema":{"example":"/scripts/postcourier-authlibup","type":"string"}},{"description":"The hook script's description.","in":"query","name":"description","required":false,"schema":{"example":"TestHook","type":"string"}},{"description":"Whether the hook script is enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","in":"query","name":"enabled","required":false,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"The type of function that the script hook launches.\n\n* `script` — Runs a script.\n* `module` — Calls a function in a module.","in":"query","name":"exectype","required":false,"schema":{"enum":["script","module"],"example":"script","type":"string"}},{"description":"The hook script's absolute file path or its `module::subroutine` invocation.","in":"query","name":"hook","required":false,"schema":{"example":"/scripts/postcourier-authlibup","type":"string"}},{"description":"The script hook's notes.","in":"query","name":"notes","required":false,"schema":{"example":"Note.","type":"string"}},{"description":"The absolute file path to the script that rolls back the hook script.","in":"query","name":"rollback","required":false,"schema":{"example":"/scripts/postcourier-authlibup","type":"string"}},{"description":"The condition when the hook script executes.\n\n* `pre` — The script runs before the function.\n* `post` — The script runs after the function.","in":"query","name":"stage","required":false,"schema":{"enum":["pre","post"],"example":"post","type":"string"}},{"description":"The script hook's priority in the hook's stage, where a lower value runs before a higher value.","in":"query","name":"weight","required":false,"schema":{"example":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"edit_hook","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update script hook","tags":["Script Hooks","Scripts Hooks"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n edit_hook \\\n id='HzEpGvT6QGUYwxuX3hWB8AUq'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/edit_hook?api.version=1&id=HzEpGvT6QGUYwxuX3hWB8AUq"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.32"}},"/validate_current_ptrs":{"get":{"description":"This function validates the pointer records (PTR) for IPv4 and IPv6 addresses an 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 (IPv4) or AAAA (IPv6) 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.","operationId":"validate_current_ptrs","parameters":[{"description":"The domain for which to validate the PTR records.\n\n**Note:**\n\nTo check multiple domains, duplicate or increment the parameter name.\nFor example, use the `domain-1`, `domain-2`, and `domain-3` parameters.","examples":{"multiple":{"summary":"Validate multiple domains' PTR records.","value":"domain-1=example.com domain-2=example2.com domain-3=example3.com"},"multiple-alternative":{"summary":"Validate multiple domains' PTR records.","value":"domain=example.com&domain=example2.com&domain=example3.com"},"single":{"summary":"Validate a single domain's PTR records.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects containing information about the account's PTR records.","example":[{"arpa_domain":"1.0.0.10.in-addr.arpa","domain":"example.com","helo":"example.com","ip_address":"10.0.0.1","ip_version":4,"nameservers":["ns1.example.com","ns2.example.com","ns3.example.com"],"ptr_records":[{"domain":"example.com","forward_records":["10.0.0.1"],"state":"VALID"}],"state":"VALID"},{"arpa_domain":"3.0.0.10.in-addr.arpa","domain":"example.com","helo":"example.com","ip_address":"10.0.0.3","ip_version":4,"nameservers":["ns1.example.com","ns2.example.com","ns3.example.com"],"ptr_records":[{"domain":"example.com","forward_records":["192.168.12.34"],"state":"FWD_MISMATCH"}],"state":"PTR_MISMATCH"},{"arpa_domain":"4.3.3.7.0.7.3.0.e.2.a.8.0.0.0.0.0.0.0.0.3.a.5.8.8.b.d.0.1.0.0.2.ip6.arpa","domain":"example.com","helo":"example.com","ip_address":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","ip_version":6,"nameservers":["ns1.example.com","ns2.example.com","ns3.example.com"],"ptr_records":[{"domain":"example.com","forward_records":["2001:0db8:85a3:0000:0000:8a2e:0370:7334"],"state":"VALID"}],"state":"VALID"},{"arpa_domain":"2.0.0.10.in-addr.arpa","domain":"example.com","helo":"example.com","ip_address":"10.0.0.2","ip_version":4,"nameservers":["ns1.example.com","ns2.example.com","ns3.example.com"],"ptr_records":[],"state":"MISSING_PTR"},{"domain":"thisotheremaildomain.com","error":"1.1.1.1.1 is not a valid IP address.","helo":"thisothermaildomain.com","ip_address":"1.1.1.1.1","ptr_records":[],"state":"ERROR"},{"arpa_domain":"4.0.0.10.in-addr.arpa","domain":"example.com","helo":"example.com","ip_address":"10.0.0.4","ip_version":4,"nameservers":["ns1.example.com","ns2.example.com","ns3.example.com"],"ptr_records":[{"domain":"example.com","forward_records":[],"state":"MISSING_FWD"}],"state":"PTR_MISMATCH"}],"items":{"properties":{"arpa_domain":{"description":"The IP address used to perform a\n[reverse DNS (rDNS) lookup](https://go.cpanel.net/HowtoConfigureReverseDNSforBINDinWHM),\nin reversed format and appended with one of the following:\n\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.","type":"string"},"domain":{"description":"The queried domain.","type":"string"},"error":{"description":"An error message that details the reason why the domain's IP address\nvalidation failed.\n\n**Note:**\n\nThe function **only** returns this value when the `state` return is\nthe `ERROR` value.","type":"string"},"helo":{"description":"The hostname that the domain uses to identify itself to remote SMTP servers.","format":"hostname","type":"string"},"ip_address":{"description":"The IPv4 or IPv6 address.\n\n**Note:**\n\nThe function does **not** return this value for a domain with an\ninvalid IP address.","type":"string"},"ip_version":{"description":"The IP version number.\n\n* `4` — An IPv4 address.\n* `6` — An IPv6 address.\n\n**Note:**\n\nThe function does **not** return this value for a domain with an\ninvalid IP address.","type":"integer"},"nameservers":{"description":"An array of the authoritative nameservers for the domain's PTR record.","items":{"type":"string"},"type":"array"},"ptr_records":{"description":"An array of objects containing the domain's PTR records.\n\n**Note:**\n\nThe function does **not** return this array for a domain with an\ninvalid IP address.","items":{"properties":{"domain":{"description":"The fully qualified domain name (FQDN) that a PTR record points to.","type":"string"},"forward_records":{"description":"An array of IP addresses that the domain resolves to for A (IPv4) and AAAA (IPv6) records.","items":{"type":"string"},"type":"array"},"state":{"description":"Whether the domain's PTR record points to a domain with an A\n(IPv4) or a AAAA (IPv6) record.\n\n* `VALID` — The PTR record is valid.\n* `MISSING_FWD` — The PTR points to a domain without an A or\nAAAA record.\n* `FWD_MISMATCH` — The PTR record points to a domain without\nan A or AAAA record that points back to the IP address.","enum":["VALID","MISSING_FWD","FWD_MISMATCH"],"type":"string"}},"type":"object"},"type":"array"},"state":{"description":"Whether the PTR records are valid for the domain.\n\n* `ERROR` — The domain's IP address is invalid. The function returns\nthe reason in the `error` return.\n* `IP_IS_PRIVATE` — The IP address exists within a range of private\nIP addresses. DNS does **not** define PTR records for private IP\naddresses.\n* `VALID` — The PTR record is valid. The function **only** returns\nthis response if **all** of an IP address's PTR records are valid.\n* `MISSING_PTR` — No PTR record exists for the IP address.\n* `PTR_MISMATCH` — One or more PTR records point to a domain that\ndoes not point back to the correct IP address.","enum":["ERROR","IP_IS_PRIVATE","VALID","MISSING_PTR","PTR_MISMATCH"],"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"validate_current_ptrs","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate domain PTR records","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n validate_current_ptrs \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/validate_current_ptrs?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"78"}},"/block_incoming_email_from_country":{"get":{"description":"This function blocks email from specific countries.","operationId":"block_incoming_email_from_country","parameters":[{"description":"The country to block.\nThe [ISO 3166-1 alpha-2 code](https://www.iso.org/iso-3166-country-codes.html) two-letter country code.\n\n**Warning:**\n\nDo **not** block the `ZZ` country code if the server uses a [NAT](https://docs.cpanel.net/knowledge-base/general-systems-administration/1-1-nat/) configuration.\n\n**Note:**\n\n * To search all available country codes, read the ISO's [Full list of Country Codes](https://www.iso.org/obp/ui) documentation.\n * To block multiple countries, duplicate or increment the parameter name. For example: `country_code-1`, `country_code-2`, and `country_code-3`.","examples":{"multiple":{"summary":"Multiple country codes.","value":"country_code-1=AA country_code-2=AB country_code-3=AC"},"single":{"summary":"A single country code.","value":"AA"}},"in":"query","name":"country_code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"updated":{"description":"Whether the function blocked one or more countries.\n* `1` — Success.\n* `0` — Failure.\n\n**Note**\nThe function returns `0` for the `updated` return if the server already blocks that country.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"block_incoming_email_from_country","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add block on emails from specific countries","tags":["Mail","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n block_incoming_email_from_country \\\n country_code='AA'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/block_incoming_email_from_country?api.version=1&country_code=AA"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"84"}},"/block_incoming_email_from_domain":{"get":{"description":"This function blocks email from specific domains.","operationId":"block_incoming_email_from_domain","parameters":[{"description":"The domain to block.\n\n**Note:**\n\n* The function returns `0` for the `updated` return if the server already blocks that domain.\n* An FQDN requires **at least** [a label, a dot (`.`), and a top-level domain (TLD)](https://en.wikipedia.org/wiki/Domain_name#Domain_name_syntax).\n* Enter an asterisk (`*`) to represent [a wildcard label or TLD](https://en.wikipedia.org/wiki/Wildcard_DNS_record).\n* To block multiple domains, duplicate or increment the parameter name.","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":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"updated":{"description":"Whether the function blocked one or more domains.\n* 1 — Success.\n* 0 — Failure.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"block_incoming_email_from_domain","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add block on emails from specific domains","tags":["Mail","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n block_incoming_email_from_domain \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/block_incoming_email_from_domain?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"84"}},"/exim_configuration_check":{"get":{"description":"This function scans the Exim configuration file for errors, and if it finds errors attempts to repair them.","operationId":"exim_configuration_check","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"message":{"description":"The reason why the configuration check failed.\n\n**Note:**\n\n The function **only** returns this parameter if the configuration file contains errors.","example":"cPanel was unable to automatically merge your Exim configuration with the new settings that shipped\nwith the build you have installed (11.38.0 (build 9999)) because you have a custom or broken configuration which\ncannot be automatically configured.\n Since this configuration update is not critical, we left your previous configuration intact until\nthe new configuration can be properly installed. In order to complete this configuration update, you will \nneed to manually merge your configuration with the new configuration settings.\n\n\nPlease follow the steps below to complete this update:\n\n\t1. <a href='javascript:select_exim_backup();'>Backup your existing configuration</a>\n\t2. <a href='javascript:select_exim_advanced();'>Notate any custom changes you have made in the ACL section in the 'Advanced Editor Tab'.</a>\n\t3. <a href='javascript:select_exim_reset();'>Choose 'Reset cPanel & WHM Exim configuration files, one option at a time, until the installed Exim configuration is valid' under the 'Reset Tab'.</a>\n\t4. <a href='javascript:select_exim_advanced();'>Reinstall your customizations in the 'Advanced Editor Tab'.</a>\n\n\nCurrent Config Version: 10.320000\nNew Config Version: 10.330000","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"exim_configuration_check","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Configuration Update Failed","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Repair Exim configuration file","tags":["Mail","Mail Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n exim_configuration_check\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/exim_configuration_check?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/fetch_mail_queue":{"get":{"description":"This function retrieves the contents of the server's mail queue.","operationId":"fetch_mail_queue","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"records":{"description":"An array of objects that contain of the message information.","items":{"properties":{"frozen":{"description":"Whether the mail message is frozen.\n* `1` — Frozen.\n* `0` — **Not** frozen.","enum":[0,1],"example":0,"type":"integer"},"msgid":{"description":"The mail message's ID.","example":"1UotX3-0002HX-Lr","type":"string"},"recipients":{"description":"An array of the mail message's recipients.","items":{"example":"pricilla@graceland.com","format":"email","type":"string"},"type":"array"},"sender":{"description":"The mail message's sender.","example":"elvis@graceland.com","format":"email","type":"string"},"size":{"description":"The mail message's size in bytes.","example":14336,"format":"bytes","minimum":0,"type":"integer"},"time":{"description":"The mail message's timestamp.","example":1371552781,"format":"unix_timestamp","type":"integer"},"user":{"description":"The mail message's owner.","example":null,"nullable":true,"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"fetch_mail_queue","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return server mail queue contents","tags":["Mail","Mail Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n fetch_mail_queue\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_mail_queue?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/get_unique_recipient_count_per_sender_for_user":{"get":{"description":"This function gets the number of unique recipients that a system user sent mail to within a period of time. It groups this data by each of the user's email accounts.","operationId":"get_unique_recipient_count_per_sender_for_user","parameters":[{"description":"The system user's username.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}},{"description":"A start time to query.","in":"query","name":"start_time","required":true,"schema":{"example":1550872800,"format":"unix_timestamp","type":"integer"}},{"description":"An end time to query.","in":"query","name":"end_time","required":true,"schema":{"example":1550923200,"format":"unix_timestamp","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects that contain a count of the number of unique recipients a system user sent mail to.","items":{"properties":{"sender":{"description":"The user's email address.","example":"username@example.com","type":"string"},"unique_recipient_count":{"description":"The number of unique recipients that the email account sent mail to.","example":51,"minimum":1,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_unique_recipient_count_per_sender_for_user","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account unique email recipients","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_unique_recipient_count_per_sender_for_user \\\n user='username' \\\n start_time='1550872800' \\\n end_time='1550923200'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_unique_recipient_count_per_sender_for_user?api.version=1&user=username&start_time=1550872800&end_time=1550923200"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"80"}},"/get_unique_sender_recipient_count_per_user":{"get":{"description":"This function gets a count of the email addresses that each system account sent mail to within a specific period of time. It groups the data by each system user for all the system's users.","operationId":"get_unique_sender_recipient_count_per_user","parameters":[{"description":"A start time to query.","in":"query","name":"start_time","required":true,"schema":{"example":1550702383,"format":"unix_timestamp","type":"integer"}},{"description":"An end time to query.","in":"query","name":"end_time","required":true,"schema":{"example":1551192100,"format":"unix_timestamp","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects that contain a count for all system users' unique email recipients.","items":{"properties":{"unique_sender_recipient_count":{"description":"A count of the unique sender-recipient pairs for mail sent during a period of time.","example":120,"minimum":1,"type":"integer"},"user":{"description":"A system user's username.","example":"username","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_unique_sender_recipient_count_per_user","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all cPanel account unique email recipients","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_unique_sender_recipient_count_per_user \\\n start_time='1550702383' \\\n end_time='1551192100'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_unique_sender_recipient_count_per_user?api.version=1&start_time=1550702383&end_time=1551192100"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"80"}},"/list_blocked_incoming_email_countries":{"get":{"description":"This function lists which countries cannot send email to the server.","operationId":"list_blocked_incoming_email_countries","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"countries":{"description":"An array of objects that contain each blocked country.","items":{"properties":{"country_code":{"description":"The [ISO-3166-1 alpha-2 code](https://www.iso.org/iso-3166-country-codes.html) of the blocked country.","example":"AD","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_blocked_incoming_email_countries","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return blocked email countries list","tags":["Mail","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_blocked_incoming_email_countries\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_blocked_incoming_email_countries?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"84"}},"/list_blocked_incoming_email_domains":{"get":{"description":"This function lists which domains cannot send email to the server.","operationId":"list_blocked_incoming_email_domains","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"domains":{"description":"An array of objects that contains each blocked domain.","items":{"properties":{"domain":{"description":"The blocked domain.","example":"example.com","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_blocked_incoming_email_domains","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return blocked email domains list","tags":["Mail","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_blocked_incoming_email_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_blocked_incoming_email_domains?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"84"}},"/remove_in_progress_exim_config_edit":{"get":{"description":"This function removes in-progress Exim configuration files after\na failed update to Exim. When cPanel & WHM attempts to update an Exim configuration,\nthe system creates dry run files to replace of the ordinary configuration\nfiles.\n\n**Note:**\n\n* If the update fails, the system leaves these dry run files in place.\n* When the user accesses the *Advanced Editor* section of WHM's [*Exim Configuration Manager*](https://docs.cpanel.net/whm/service-configuration/exim-configuration-manager/)\ninterface (_Home >> Service Configuration >> Exim Configuration Manager_),\nthey access these dry run files instead of the actual configuration files.","operationId":"remove_in_progress_exim_config_edit","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"remove_in_progress_exim_config_edit","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Removed OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove Exim configuration files after failed update","tags":["Server Administration","Mail Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n remove_in_progress_exim_config_edit\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remove_in_progress_exim_config_edit?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/set_manual_mx_redirects":{"get":{"description":"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 /etc/manualmx file.\n\n**Note:**\n\n To remove a domain's manual MX redirection, use the WHM API 1 unset_manual_mx_redirect function.","operationId":"set_manual_mx_redirects","parameters":[{"description":"The domain for which to add a manual MX redirect entry.\n\n**Note:**\n\n To add multiple domain entries, increment the parameter. For example, use the domain, domain-1, and domain-2 parameters. For multiple domains, you must include its corresponding mx_host value.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","type":"string"}},{"description":"The domain or IP address (IPv4 or IPv6) to redirect the domain value's emails to.\n\n**Note:**\n\n To add multiple MX hosts, increment the parameter. For example, use the mx_host, mx_host-1, and mx_host-2 parameters. For multiple MX hosts, you must include its corresponding domain value.","in":"query","name":"mx_host","required":true,"schema":{"example":"mailhostexample.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"additionalProperties":{"description":"The domain’s former MX redirect target, or null if the domain did not have an MX redirect target before.","example":"mailhostexample.com","nullable":true,"type":"string","x-additionalPropertiesName":"domain"},"description":"The former manual MX redirect entry for each domain.","example":{"example.com":"mailhostexample.com","example.org":null},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_manual_mx_redirects","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add manual mail exchanger redirect record","tags":["Mail","Mail DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_manual_mx_redirects \\\n domain='example.com' \\\n mx_host='mailhostexample.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_manual_mx_redirects?api.version=1&domain=example.com&mx_host=mailhostexample.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"90"}},"/unblock_incoming_email_from_domain":{"get":{"description":"This function unblocks email from specific domains.","operationId":"unblock_incoming_email_from_domain","parameters":[{"description":"The domain to unblock.\n\n**Note:**\n\n* The function returns `0` for the updated return if the server already doesn't block that domain.\n* An FQDN requires **at least** [a label, a dot (`.`), and a top-level domain (TLD)](https://en.wikipedia.org/wiki/Domain_name#Domain_name_syntax).\n* Enter an asterisk (`*`) to represent [a wildcard label or TLD](https://en.wikipedia.org/wiki/Wildcard_DNS_record).\n* To unblock multiple domains, duplicate or increment the parameter name.","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":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"updated":{"description":"Whether the function unblocked one or more domains.\n* `1` — Success.\n* `0` — Failure.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"unblock_incoming_email_from_domain","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove block on emails from specific domains","tags":["Mail","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n unblock_incoming_email_from_domain \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/unblock_incoming_email_from_domain?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"84"}},"/validate_current_installed_exim_config":{"get":{"description":"This function validates the system's current Exim configuration.","operationId":"validate_current_installed_exim_config","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"message":{"description":"A list of Exim's configuration parameters.","example":"<pre>Doing Dry Run\nDry Run ok\nEnabled system filter options: attachments| fail_spam_score_over_int|spam_rewrite\nEnabled ACL options in block ACL_MAIL_PRE_BLOCK: default_mail_pre\nEnabled ACL options in block ACL_RBL_BLOCK: primary_hostname_bl\n Enabled ACL options in block ACL_RECIPIENT_POST_BLOCK: default_recipient_post\nEnabled ACL options in block ACL_SPAM_SCAN_CHECK_BLOCK: default_spam_scan_check\nEnabled ACL options in block ACL_CHECK_MESSAGE_PRE_BLOCK: default_check_message_pre \nEnabled ACL options in block ACL_CONNECT_POST_BLOCK: default_connect_post \nEnabled ACL options in block ACL_CONNECT_BLOCK: ratelimit|spammerlist \nEnabled ACL options in block ACL_POST_RECP_VERIFY_BLOCK: dictionary_attack\nEnabled ACL options in block ACL_IDENTIFY_SENDER_BLOCK: default_identify_sender\nEnabled ACL options in block ACL_MAIL_BLOCK: requirehelo| requirehelonoforge|requirehelosyntax\nEnabled ACL options in block ACL_RATELIMIT_SPAM_BLOCK: ratelimit_spam_score_over_int\nEnabled ACL options in block ACL_CHECK_MESSAGE_POST_BLOCK: default_check_message_post\nEnabled ACL options in block ACL_POST_SPAM_SCAN_CHECK_BLOCK: mailproviders \nEnabled ACL options in block ACL_SPAM_SCAN_BLOCK: default_spam_scan \nEnabled ACL options in block ACL_RATELIMIT_BLOCK: 0tracksenders\nEnabled ACL options in block ACL_NOTQUIT_BLOCK: ratelimit\nEnabled ACL options in block ACL_RECP_VERIFY_BLOCK: default_recp_verify\nEnabled ACL options in block ACL_PRE_SPAM_SCAN: mailproviders\nEnabled ACL options in block ACL_SPAM_BLOCK: deny_spam_score_over_int\nEnabled ACL options in block ACL_EXISCAN_BLOCK: default_exiscan\nEnabled ACL options in block ACL_RECIPIENT_BLOCK: default_recipient\nEnabled ACL options in block ACL_MAIL_POST_BLOCK: default_mail_post\nThe system detected spam handling in acls and will now disable Apache SpamAssassin in routers and transports!\nThe Apache SpamAssassin method remains unchanged.\nConfigured options list is:\nACL: acl_smtp_connect is active\nACL: acl_smtp_data is active\nACL: acl_smtp_mail is active\nACL: acl_smtp_notquit is active\nACL: acl_smtp_rcpt is active\nProvided options list is: daemon_smtp_ports| tls_on_connect_ports|system_filter_user|system_filter_group|tls_require_ciphers|hostlist loopback|hostlist senderverifybypass_hosts|hostlist skipsmtpcheck_hosts|hostlist spammeripblocks|hostlist backupmx_hosts|hostlist trustedmailhosts|hostlist relay_hosts| domainlist user_domains|remote_max_parallel|smtp_receive_timeout| ignore_bounce_errors_after|rfc1413_query_timeout|timeout_frozen_after|auto_thaw| callout_domain_negative_expire|callout_negative_expire|acl_smtp_connect| acl_smtp_data|acl_smtp_mail|acl_smtp_notquit|acl_smtp_rcpt|perl_at_start| daemon_smtp_ports|tls_on_connect_ports|system_filter_user|system_filter_ group|tls_require_ciphers|spamd_address\nExim Insert Regex is: virtual_userdelivery| virtual_aliases|lookuphost|virtual_user|address_pipe|virtual_sa_user|localuser\nExim Replace Regex is: virtual_sa_user|sa_localuser|virtual_sa_userdelivery| local_sa_delivery|central_filter|central_user_filter|democheck|fail_remote_domains| fixed_login|fixed_plain|has_alias_but_no_mailbox_discarded_to_prevent_loop|literal| local_delivery|local_delivery_spam|localuser|localuser_spam|lookuphost|remote_smtp| secure_login|secure_plain|userforward|virtual_aliases|virtual_aliases_nostar| virtual_user|virtual_user_spam|virtual_userdelivery|virtual_userdelivery_spam\nExim Match Insert Regex is: quota_directory|maildir_format\nExim version 4.76 #1 built 16- Aug-2011 11:41:07\nCopyright (c) University of Cambridge, 1995 - 2007\nBerkeley DB: Sleepycat Software: Berkeley DB 4.3.29: (July 12, 2010)\nSupport for: crypteq iconv() IPv6 PAM Perl OpenSSL Content_Scanning DKIM Old_Demime Experimental_SPF Experimental_SRS\nLookups (built-in): lsearch wildlsearch nwildlsearch iplsearch dbm dbmnz passwd\nAuthenticators: cram_md5 dovecot plaintext spa\nRouters: accept dnslookup ipliteral manualroute queryprogram redirect\nTransports: appendfile/maildir autoreply pipe smtp\nSize of off_t: 8\n\n</pre>","format":"HTML","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"validate_current_installed_exim_config","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Your configuration is currently valid.","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate Exim configuration","tags":["Mail","Mail Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n validate_current_installed_exim_config\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/validate_current_installed_exim_config?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/unblock_incoming_email_from_country":{"get":{"description":"This function unblocks email from specific countries.","operationId":"unblock_incoming_email_from_country","parameters":[{"description":"The country to unblock. A valid [ISO 3166-1 alpha-2 code](https://www.iso.org/iso-3166-country-codes.html) two-letter country code.\n\n**Note:**\n* To search all available country codes, read the ISO's [Full list of Country Codes](https://www.iso.org/obp/ui) documentation.\n* To unblock multiple countries, duplicate or increment the parameter name. For example, to unblock three countries, you could:\n - Use the `country_code` parameter multiple times.\n - Use the `country_code`, `country_code-1`, and `country_code-2` parameters.","examples":{"multiple":{"description":"To unblock multiple country codes.","value":"country_code=US&country_code=AD"},"multiple-alternative":{"description":"To unblock multiple country codes using index parameters.","value":"country_code=US&country_code-1=AD&country_code-2=ES"},"single":{"description":"To unblock one country code.","value":"US"}},"in":"query","name":"country_code","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"updated":{"description":"Whether the function unblocked one or more countries.\n* `1` - Success.\n* `0` - Failure.\n\n**Note:**\nIf the server already doesn't block that country, `updated` will return `0`.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"unblock_incoming_email_from_country","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove block on emails from specific countries","tags":["Mail","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n unblock_incoming_email_from_country\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/unblock_incoming_email_from_country?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"84"}},"/validate_exim_configuration_syntax":{"get":{"description":"This function evaluates and validates an Exim configuration file's syntax.\n\n**Note:**\n\nOn servers that run CentOS 7, you may see a `named` warning about the absence of SPF resource\nrecords on DNS.\n * This warning is not relevant on CentOS 7 servers, because\n [RFC 7208 deprecated SPF records](https://tools.ietf.org/html/rfc7208).\n CentOS 7 servers use TXT records instead of SPF records.\n * Red Hat 7.1 and CentOS 7.1 both contain `bind-9.9.4-23.el7`, which is an updated version of\n BIND that complies with RFC 7208. To resolve this issue, update your operating system to a\n version that contains the updated version of BIND. For more information, read the\n [Red Hat Bugzilla case about SPF record errors](https://bugzilla.redhat.com/show_bug.cgi?id=1215164).","operationId":"validate_exim_configuration_syntax","parameters":[{"description":"The Exim configuration file's raw text.\n\n**Note:**\n\nIf you do not use this parameter, the function will analyze Exim's current configuration.","in":"query","name":"cfg_text","required":false,"schema":{"example":"RAW_CONFIGURATION_TEXT","format":"HTML","type":"string"}},{"description":"The Exim configuration file's section to check.\n\n**Note:**\n\nIf you use this parameter, pass **only** the desired section to validate as the\n`cfg_text` value.","in":"query","name":"section","required":false,"schema":{"example":"acl","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"error_msg":{"summary":"An invalid Exim configuration.","value":{"command":"validate_exim_configuration_syntax","data":{"broken_cfg_html":"RAW_CONFIGURATION_TEXT","broken_cfg_text":"==>RAW_CONFIGURATION_TEXT<==\n","error_line":1,"error_msg":"This is an error message."},"output":{"raw":"\n"},"reason":"OK","result":1,"version":1}},"exim_caps":{"summary":"A valid Exim configuration.","value":{"command":"validate_exim_configuration_syntax","data":{"exim_caps":{"add_header":1,"archive":1,"boxtrapper":1,"content_scanning":1,"directives":{"accept_8bitmime":1,"acl_not_smtp":1,"acl_not_smtp_mime":1,"acl_not_smtp_start":1,"acl_smtp_auth":1,"acl_smtp_connect":1,"acl_smtp_data":1,"acl_smtp_data_prdr":1,"acl_smtp_dkim":1,"acl_smtp_etrn":1,"acl_smtp_expn":1,"acl_smtp_helo":1,"acl_smtp_mail":1,"acl_smtp_mailauth":1,"acl_smtp_mime":1,"acl_smtp_notquit":1,"acl_smtp_predata":1,"acl_smtp_quit":1,"acl_smtp_rcpt":1,"acl_smtp_starttls":1,"acl_smtp_vrfy":1,"add_environment":1,"admin_groups":1,"allow_domain_literals":1,"allow_mx_to_ip":1,"allow_utf8_domains":1,"auth_advertise_hosts":1,"auto_thaw":1,"av_scanner":1,"bi_command":1,"bounce_message_file":1,"bounce_message_text":1,"bounce_return_body":1,"bounce_return_linesize_limit":1,"bounce_return_message":1,"bounce_return_size_limit":1,"bounce_sender_authentication":1,"callout_domain_negative_expire":1,"callout_domain_positive_expire":1,"callout_negative_expire":1,"callout_positive_expire":1,"callout_random_local_part":1,"check_log_inodes":1,"check_log_space":1,"check_rfc2047_length":1,"check_spool_inodes":1,"check_spool_space":1,"daemon_smtp_ports":1,"daemon_startup_retries":1,"daemon_startup_sleep":1,"delay_warning":1,"delay_warning_condition":1,"deliver_drop_privilege":1,"deliver_queue_load_max":1,"delivery_date_remove":1,"disable_ipv6":1,"dkim_verify_signers":1,"dns_again_means_nonexist":1,"dns_check_names_pattern":1,"dns_csa_search_limit":1,"dns_csa_use_reverse":1,"dns_dnssec_ok":1,"dns_ipv4_lookup":1,"dns_retrans":1,"dns_retry":1,"dns_trust_aa":1,"dns_use_edns0":1,"drop_cr":1,"dsn_advertise_hosts":1,"dsn_from":1,"envelope_to_remove":1,"errors_copy":1,"errors_reply_to":1,"event_action":1,"exim_group":1,"exim_path":1,"exim_user":1,"extra_local_interfaces":1,"extract_addresses_remove_arguments":1,"finduser_retries":1,"freeze_tell":1,"gecos_name":1,"gecos_pattern":1,"gnutls_allow_auto_pkcs11":1,"gnutls_compat_mode":1,"gnutls_require_kx":1,"gnutls_require_mac":1,"gnutls_require_protocols":1,"header_line_maxsize":1,"header_maxsize":1,"headers_charset":1,"helo_accept_junk_hosts":1,"helo_allow_chars":1,"helo_lookup_domains":1,"helo_try_verify_hosts":1,"helo_verify_hosts":1,"hold_domains":1,"host_lookup":1,"host_lookup_order":1,"host_reject_connection":1,"hosts_connection_nolog":1,"hosts_treat_as_local":1,"ignore_bounce_errors_after":1,"ignore_fromline_hosts":1,"ignore_fromline_local":1,"keep_environment":1,"keep_malformed":1,"local_from_check":1,"local_from_prefix":1,"local_from_suffix":1,"local_interfaces":1,"local_scan_timeout":1,"local_sender_retain":1,"localhost_number":1,"log_file_path":1,"log_selector":1,"log_timezone":1,"lookup_open_max":1,"max_username_length":1,"message_body_newlines":1,"message_body_visible":1,"message_id_header_domain":1,"message_id_header_text":1,"message_logs":1,"message_size_limit":1,"mua_wrapper":1,"never_users":1,"openssl_options":1,"percent_hack_domains":1,"perl_at_start":1,"perl_startup":1,"pid_file_path":1,"pipelining_advertise_hosts":1,"prdr_enable":1,"preserve_message_logs":1,"primary_hostname":1,"print_topbitchars":1,"process_log_path":1,"prod_requires_admin":1,"qualify_domain":1,"qualify_recipient":1,"queue_domains":1,"queue_list_requires_admin":1,"queue_only":1,"queue_only_file":1,"queue_only_load":1,"queue_only_load_latch":1,"queue_only_override":1,"queue_run_in_order":1,"queue_run_max":1,"queue_smtp_domains":1,"receive_timeout":1,"received_header_text":1,"received_headers_max":1,"recipient_unqualified_hosts":1,"recipients_max":1,"recipients_max_reject":1,"remote_max_parallel":1,"remote_sort_domains":1,"retry_data_expire":1,"retry_interval_max":1,"return_path_remove":1,"rfc1413_hosts":1,"rfc1413_query_timeout":1,"sender_unqualified_hosts":1,"slow_lookup_log":1,"smtp_accept_keepalive":1,"smtp_accept_max":1,"smtp_accept_max_nonmail":1,"smtp_accept_max_nonmail_hosts":1,"smtp_accept_max_per_connection":1,"smtp_accept_max_per_host":1,"smtp_accept_queue":1,"smtp_accept_queue_per_connection":1,"smtp_accept_reserve":1,"smtp_active_hostname":1,"smtp_banner":1,"smtp_check_spool_space":1,"smtp_connect_backlog":1,"smtp_enforce_sync":1,"smtp_etrn_command":1,"smtp_etrn_serialize":1,"smtp_load_reserve":1,"smtp_max_synprot_errors":1,"smtp_max_unknown_commands":1,"smtp_ratelimit_hosts":1,"smtp_ratelimit_mail":1,"smtp_ratelimit_rcpt":1,"smtp_reserve_hosts":1,"smtp_return_error_details":1,"spamd_address":1,"spf_guess":1,"split_spool_directory":1,"spool_directory":1,"sqlite_lock_timeout":1,"srs_config":1,"srs_hashlength":1,"srs_hashmin":1,"srs_maxage":1,"srs_secrets":1,"srs_usehash":1,"srs_usetimestamp":1,"strict_acl_vars":1,"strip_excess_angle_brackets":1,"strip_trailing_dot":1,"syslog_duplication":1,"syslog_facility":1,"syslog_processname":1,"syslog_timestamp":1,"system_filter":1,"system_filter_directory_transport":1,"system_filter_file_transport":1,"system_filter_group":1,"system_filter_pipe_transport":1,"system_filter_reply_transport":1,"system_filter_user":1,"tcp_nodelay":1,"timeout_frozen_after":1,"timezone":1,"tls_advertise_hosts":1,"tls_certificate":1,"tls_crl":1,"tls_dh_max_bits":1,"tls_dhparam":1,"tls_eccurve":1,"tls_ocsp_file":1,"tls_on_connect_ports":1,"tls_privatekey":1,"tls_remember_esmtp":1,"tls_require_ciphers":1,"tls_try_verify_hosts":1,"tls_verify_certificates":1,"tls_verify_hosts":1,"trusted_groups":1,"trusted_users":1,"unknown_login":1,"unknown_username":1,"untrusted_set_sender":1,"uucp_from_pattern":1,"uucp_from_sender":1,"warn_message_file":1,"write_rejectlog":1},"dkim":1,"domainkeys":0,"dovecot":1,"exiscan":1,"force_command":1,"maildir":1,"mailman":1,"no_forward_outbound_spam":1,"no_forward_outbound_spam_over_int":0,"notquit":1,"passwd":1,"rewrite_from_all":0,"rewrite_from_remote":0,"spf":1,"srs":0}},"output":{"raw":"\n"},"reason":"OK","result":1,"version":1}}},"schema":{"properties":{"data":{"anyOf":[{"description":"The function returns this object for an invalid Exim configuration.","properties":{"broken_cfg_html":{"description":"The line with the broken configuration, in HTML format.","example":"RAW_CONFIGURATION_TEXT\n","format":"HTML","type":"string"},"broken_cfg_text":{"description":"The line that includes the broken configuration.","example":"==>RAW_CONFIGURATION_TEXT<==\n","format":"HTML","type":"string"},"error_line":{"description":"The first line in the Exim configuration file that contains an error.","minimum":1,"type":"integer"},"error_msg":{"description":"Any error messages that the validation script encountered.","type":"string"}},"type":"object"},{"properties":{"exim_caps":{"description":"The function returns this object for a valid Exim configuration.","properties":{"add_header":{"description":"Whether the server supports the `add_header` directive.\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"},"archive":{"description":"Whether the server supports system-wide archives.\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"},"boxtrapper":{"description":"Whether the server supports BoxTrapper functionality.\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"},"content_scanning":{"description":"Whether the server supports content scanning functionality.\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"},"directives":{"additionalProperties":{"description":"Whether the directive is active or inactive on the server.\n\n* `1` — Active.\n* `0` — Inactive.\n\n**Note:**\n\nThe return's name is the directive's name.","enum":[1,0],"type":"integer"},"description":"A list of individual Exim directives.","type":"object"},"dkim":{"description":"Whether the server supports DomainKeys Identified Mail (DKIM).\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"},"domainkeys":{"description":"Whether the server supports DKIM.\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"},"dovecot":{"description":"Whether the server supports Dovecot authentication.\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"},"exiscan":{"description":"Whether the server contains exiscan, which scans messages from\nauthenticated senders for malware.\n\n* `1` — Contains exiscan.\n* `0` — Does **not** contain exiscan.","enum":[1,0],"type":"integer"},"force_command":{"description":"Whether the server supports the `force_command` directive for\npipe transports.\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"},"maildir":{"description":"Whether the server supports the Maildir format.\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"},"mailman":{"description":"Whether the server supports the Mailman feature.\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"},"no_forward_outbound_spam":{"description":"Whether the server will refuse to forward outbound spam if it\nmatches the Apache SpamAssassin™ internal `spam_score` setting.\n\n* `1` — Server refuses to forward.\n* `0` — Server allows.","enum":[1,0],"type":"integer"},"no_forward_outbound_spam_over_int":{"description":"Whether the server will refuse to forward outbound spam if it\nmatches a defined Apache SpamAssassin score.\n\n* `1` — Server refuses to forward.\n* `0` — Server allows.","enum":[1,0],"type":"integer"},"notquit":{"description":"Whether the server supports the `acl_smtp_notquit` ACL, which runs\nwhen an SMTP session ends without a `QUIT`.\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"},"passwd":{"description":"Whether the server supports password authentication.\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"},"rewrite_from_all":{"description":"Whether the server supports the rewrite function on all incoming\nmail.\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"},"rewrite_from_remote":{"description":"Whether the server can rewrite the outgoing `From:` header to the\nactual sender.\n\n* `1` — Can rewrite.\n* `0` — **Cannot** rewrite.","enum":[1,0],"type":"integer"},"spf":{"description":"Whether the server supports SPF checks.\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"},"srs":{"description":"Whether the server supports the Sender Rewriting Scheme (SRS).\n\n* `1` — Supports.\n* `0` — Does **not** support.","enum":[1,0],"type":"integer"}}}},"type":"object"}],"description":"An object containing a valid or invalid Exim configuration information.","type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"validate_exim_configuration_syntax","type":"string"},"output":{"description":"The function's raw HTML output, if any exists.","format":"HTML","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate Exim configure file syntax","tags":["Mail","Mail Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n validate_exim_configuration_syntax\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/validate_exim_configuration_syntax?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/create_featurelist":{"get":{"description":"This function creates or updates a feature list.\n\n**Note:**\n\nA reseller **must** possess the\n[Add/Remove Package feature](https://docs.cpanel.net/whm/resellers/edit-reseller-nameservers-and-privileges/#packages)\nto use this function.","operationId":"create_featurelist","parameters":[{"description":"The feature list's name.","in":"query","name":"featurelist","required":true,"schema":{"example":"CustomFeatureList","type":"string"}},{"description":"Whether to add a specific feature in the feature list.\n\n* `1` — Add the feature.\n* `0` — Do **not** add the feature.\n\n**Note:**\n\n* The parameter's name is a feature's name. For example, the `changemx=1`\nadds the *Change Mail Exchanger* feature to the feature list.\n\n* You can add or omit multiple features.","in":"query","name":"featurelistname","required":false,"schema":{"default":0,"enum":[1,0],"example":1,"type":"integer"}},{"description":"Whether to overwrite an existing feature list.\n\n* `1` — Overwrite.\n* `0` — Do **not** overwrite.","in":"query","name":"overwrite","required":false,"schema":{"default":0,"enum":[1,0],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"featurelist":{"description":"The feature list's name.","example":"Arthur","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"create_featurelist","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create feature list","tags":["Packages","Feature Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n create_featurelist \\\n featurelist=Arthur webmail=1 changemx=1 overwrite=1\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/create_featurelist?api.version=1&featurelist=Arthur&webmail=1&changemx=1&overwrite=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/suspendacct":{"get":{"description":"This function suspends an account.","operationId":"suspendacct","parameters":[{"description":"The account to suspend.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}},{"description":"The reason for suspension.\n\n**Important:**\n\n We strongly recommend that you provide a reason for suspension whenever you suspend an account.","in":"query","name":"reason","required":false,"schema":{"default":"Unknown","example":"Nonpayment","type":"string"}},{"description":"Whether to allow only the `root` user to unsuspend the account.\n* `1` - **Only** the `root` user can unsuspend the account.\n* `0` - The `root` user or the account's owner can unsuspend the account.","in":"query","name":"disallowun","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to skip suspension of the account's FTP accounts.\n* `1` - Do **not** suspend the FTP accounts.\n* `0` - Suspend the FTP accounts.","in":"query","name":"leave-ftp-accts-enabled","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"suspendacct","type":"string"},"output":{"description":"System messages generated while suspending the account.","properties":{"raw":{"description":"The raw system message.","example":"Changing Shell to /bin/false...Changing shell for username. Warning: \"/bin/false\" is not listed in /etc/shells. Shell changed. Done Locking Password...Locking password for user username. passwd: Success Done Suspending mysql users Using Universal Quota Support (quota=0) Suspending websites... Using Universal Quota Support (quota=0) Suspending FTP accounts... Updating FTP passwords for username FTP password files updated. FTP vhost passwords synced username's account has been suspended\n","type":"string"}},"type":"object"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Suspend cPanel account","tags":["Suspensions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n suspendacct \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/suspendacct?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/delete_featurelist":{"get":{"description":"This function deletes a feature list.","operationId":"delete_featurelist","parameters":[{"description":"The feature list's name.","in":"query","name":"featurelist","required":true,"schema":{"example":"TestList","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"deleted_featurelist":{"description":"The deleted feature list's name.","example":"TestList","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"delete_featurelist","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete feature list","tags":["Packages","Feature Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n delete_featurelist \\\n featurelist='TestList'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_featurelist?api.version=1&featurelist=TestList"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/get_feature_metadata":{"get":{"description":"This function lists the details of the authenticated user's available feature lists.","operationId":"get_feature_metadata","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"features":{"description":"An array of objects containing information about a feature.","items":{"properties":{"id":{"description":"The feature's ID.","example":"addondomains","type":"string"},"is_cpaddon":{"description":"Whether the feature is a\n[cPAddon](https://docs.cpanel.net/cpanel/software/site-software/).\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.\n\n* `1` — Plugin.\n* `0` — **Not** a plugin.","enum":[1,0],"example":0,"type":"integer"},"name":{"description":"The feature's name.","example":"Addon Domain Manager","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_feature_metadata","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return current user's available feature lists info","tags":["Packages","Feature Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_feature_metadata\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_feature_metadata?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/get_feature_names":{"get":{"description":"This function lists all available features.","operationId":"get_feature_names","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"feature":{"description":"An array of objects that contain a list of available features.","items":{"properties":{"id":{"description":"The feature's ID.","example":"sslmanager","type":"string"},"name":{"description":"The feature's name.","example":"SSL Manager","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_feature_names","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all features","tags":["Packages","Feature Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_feature_names\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_feature_names?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/get_featurelists":{"get":{"description":"This function lists the authenticated user's available feature lists.\n\n**Notes:**\n\n* When you call this function with the `root` account, it returns **all** feature lists on the server.\n* When you call this function with a reseller account, it **only** returns feature lists that the account owns.","operationId":"get_featurelists","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"featurelists":{"description":"An array of available feature lists.","example":["default","disabled","reseller1_test1","reseller1_test2"],"items":{"example":"default","type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_featurelists","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return current user's available feature lists","tags":["Packages","Feature Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_featurelists\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_featurelists?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/get_users_features_settings":{"get":{"description":"This function lists the features settings of cPanel accounts.","operationId":"get_users_features_settings","parameters":[{"description":"The user's username.\n\n**Note:**\n\nTo check multiple users, increment the parameter name. For example, `user-1`, `user-2`, and `user-3`.","examples":{"multiple":{"description":"Multiple users.","value":"user-1=example1 user-2=example2 user-3=example3"},"single":{"description":"A single user.","value":"example"}},"in":"query","name":"user","required":true,"schema":{"type":"string"}},{"description":"The feature's name.\n\n**Note:**\n\n* To check multiple features, increment the parameter name. For example, `feature-1`, `feature-2`, and `feature-3`.\n* If you use this parameter, you **must** enter a feature name, or the function returns an error. If you do **not** use this parameter, the function returns data for all features on the server.","examples":{"multiple":{"description":"Multiple feature.","value":"feature-1=autossl feature-2=addoncgi feature-3=addondomains"},"single":{"description":"A single feature.","value":"autossl"}},"in":"query","name":"feature","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"users_features_settings":{"description":"An array of objects that contain information about the feature list settings.","items":{"properties":{"cpuser_setting":{"description":"The user's setting for the feature in their `cpuser` file, which overrides the `feature_list_setting` return.\n* `1` - Enabled.\n* `0` - Disabled.\n* `null` — The feature is **not** defined in the feature list.","enum":[1,0],"example":1,"nullable":true,"type":"integer"},"feature":{"description":"The feature name.","example":"autossl","type":"string"},"feature_list":{"description":"The feature list's name.","example":"autossl","type":"string"},"feature_list_setting":{"description":"The user's feature list setting.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[1,0],"example":1,"type":"integer"},"user":{"description":"The user's username.","example":"example","format":"username","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_users_features_settings","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel accounts' feature settings","tags":["Packages","Feature Access"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_users_features_settings \\\n user='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_users_features_settings?api.version=1&user=example"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/get_featurelist_data":{"get":{"description":"This function lists features in a specific feature list.","operationId":"get_featurelist_data","parameters":[{"description":"The feature list for which to list information.","in":"query","name":"featurelist","required":true,"schema":{"example":"\"Mail Only\"","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"featurelist":{"description":"The feature list's name.","example":"Mail Only","type":"string"},"features":{"description":"An array of objects containing the feature's information.","items":{"properties":{"id":{"description":"The feature's ID.","example":"email_trace","type":"string"},"is_disabled":{"description":"Whether the feature is disabled.\n\n* `1` — Disabled.\n* `0` — **Not** disabled.\n\n**Note:**\n\n* The `disabled` feature list does **not** use this return.\n* Users on your server can't access disabled features. For more\ninformation, read our\n[Feature Manager](https://go.cpanel.net/whmdocsFeatureManager)\ndocumentation.","enum":[1,0],"example":0,"type":"integer"},"value":{"description":"Whether the feature list includes the feature.\n\n* `1` — The feature list includes this feature.\n* `0` — The feature list does **not** include this feature.\n\n**Note:**\n\nThe `disabled` feature list uses the **opposite** logic for this return.\n\n* `1` — The `disabled` feature list does **not** include this feature.\n* `0` — The `disabled` feature list includes this feature.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_featurelist_data","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return feature list configuration","tags":["Packages","Feature Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_featurelist_data \\\n featurelist='\"Mail Only\"'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_featurelist_data?api.version=1&featurelist=%22Mail%20Only%22"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/update_featurelist":{"get":{"description":"This function creates or updates a feature list.","operationId":"update_featurelist","parameters":[{"description":"The feature list's name.","in":"query","name":"featurelist","required":true,"schema":{"example":"TheBlackLagoon","type":"string"}},{"description":"Whether to include the feature in the feature list.\n\n**Notes:**\n\n This parameter's name is the feature's name. If you do not specify any features, the system will disable all features in the feature list.","in":"query","name":"feature name","required":false,"schema":{"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"featurelist":{"description":"The feature list's name. A valid string.","example":"TheBlackLagoon","type":"string"},"invalid_features":{"description":"An array of invalid feature names. This array includes the invalid feature return.","items":{"properties":{"invalid feature":{"description":"Whether the feature exists in the feature list.\n\n**Note:**\n\n The feature's name is the return's name.\n- 1 The feature exists in the feature list.\n- 0 The feature does not exist in the feature list.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"updated_features":{"description":"hash of features in the feature list. This hash includes the feature name return.","properties":{"autoresponders":{},"feature name":{"description":"Whether the feature exists in the feature list.\n\n**Note:**\n\n The feature's name is the return's name.\n- 1 The feature exists in the feature list.\n- 0 The feature does not exist in the feature list.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"update_featurelist","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update feature list","tags":["Packages","Feature Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n update_featurelist \\\n featurelist='TheBlackLagoon'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/update_featurelist?api.version=1&featurelist=TheBlackLagoon"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/unsuspendacct":{"get":{"description":"This function unsuspends an account.\n\n**Note:**\n\n**Only** the `root` account and `root`-enabled resellers can unsuspend a locked account.","operationId":"unsuspendacct","parameters":[{"description":"The account to unsuspend.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}},{"description":"Whether to retain any [service proxies](https://go.cpanel.net/serviceproxyglossary) on an account.\n* `1` — Retain service proxies.\n* `0` — Do **not** retain service proxies.","in":"query","name":"retain-service-proxies","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"unsuspendacct","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Unsuspend cPanel account","tags":["Suspensions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n unsuspendacct \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/unsuspendacct?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/list_hooks":{"get":{"description":"This function lists the server's script hooks.","operationId":"list_hooks","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"categories":{"description":"An array of objects containing hook categories.","items":{"properties":{"category":{"description":"The script hook's category.","example":"RPM::Versions","type":"string"},"events":{"description":"An array of objects containing events.","items":{"properties":{"event":{"description":"The event that triggers the script hook.","example":"MariaDB-server","type":"string"},"stage_order":{"description":"When the hook script will execute. It is possible for a hook script\nto have both values.\n\n* `pre` — The script runs before the function.\n* `post` — The script runs after the function.","example":["pre","post"],"items":{"type":"string"},"type":"array"},"stages":{"description":"An array of objects containing stage information.","items":{"properties":{"actions":{"description":"An array of objects containing information about hook script actions.","items":{"properties":{"blocking":{"description":"Whether the script hook has a blocking contest.\n\n* `1` — Blocking contest.\n* `0` — No blocking contest.","enum":[1,0],"example":0,"type":"integer"},"category":{"description":"The script hook's category.","example":"RPM::Versions","type":"string"},"check":{"description":"The absolute file path to the script that runs after the hook script to check the results.","example":null,"nullable":true,"type":"string"},"description":{"description":"The hook script's description.","example":"A script description.","nullable":true,"type":"string"},"enabled":{"description":"Whether the hook script is enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":1,"type":"integer"},"escalateprivs":{"description":"Whether the hook script will run with escalated root privileges.\n\n* `1` — Runs with escalated privileges.\n* `0` — Does not run with escalated privileges.","enum":[0,1],"example":0,"type":"integer"},"event":{"description":"The event that triggers the script hook.","example":"MariaDB-server","type":"string"},"exectype":{"description":"The type of function that the script hook launches.\n\n* `script` — A script function.\n* `module` — A Perl module function.","enum":["script","module"],"example":"script","type":"string"},"hook":{"description":"The absolute file path to the hook script.","example":"/scripts/postcourier-authlibup","type":"string"},"id":{"description":"The script hook's ID.","example":"KQVO65K_8MWe__3JMPETn43S","type":"string"},"rollback":{"description":"The absolute file path to the script that can roll back the hook script.","example":null,"nullable":true,"type":"string"},"stage":{"description":"When the hook script will execute.\n\n* `pre` — The script runs before the function.\n* `post` — The script runs after the function.","example":"post","type":"string"},"weight":{"description":"The priority of the script hook, where lower values run before higher values.","example":100,"minimum":1,"type":"integer"}},"type":"object"},"type":"array"},"attributes":{"description":"A list of hook script attributes.","properties":{"blocking":{"description":"Whether the script hook contains a blocking context.\n\n* `1` — Blocking context.\n* `0` — No blocking context.","enum":[1,0],"example":0,"type":"integer"},"escalateprivs":{"description":"Whether the hook script will run with escalated root\nprivileges.\n\n* `1` — Runs with escalated privileges.\n* `0` — Does not run with escalated privileges.","enum":[1,0],"example":0,"type":"integer"}},"type":"object"},"description":{"description":"The hook script's description.","example":"My hook script.","type":"string"},"stage":{"description":"When the hook script will execute.\n\n* `pre` — The script runs before the function.\n* `post` — The script runs after the function.","example":"post","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_hooks","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return script hooks list","tags":["Script Hooks","Scripts Hooks"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_hooks\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_hooks?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.32"}},"/sethostname":{"get":{"description":"This function changes the server's hostname.\n\n**Warning:**\n\n* Do **not** select a hostname that begins with `www` or a number, or a\nhostname that ends with a hyphen (`-`) character.\n* You **must** use a fully-qualified domain name (FQDN) that contains two periods\n(for example, `hostname.example.com`).\n* Do **not** choose a hostname that a cPanel account on your server will use.\n* Do **not** choose a potential service subdomain (proxy subdomain) as a hostname\n(for example, `cpanel.example.com` or `whm.example.com`).\n\n**Important:**\n\nIf you update your hostname, the system blocks user access to cPanel's [*Calendars and Contacts*](https://go.cpanel.net/calendars) interface (*cPanel >> Home >> Email >> Calendars and Contacts*).\n\nThe system restores access to this interface after the hostname update finishes.\nFor more information, read our\n[Interface Lock Scripts](https://docs.cpanel.net/knowledge-base/cpanel-product/interface-lock-scripts/)\ndocumentation.\n\n**Note:**\n\nWhenever you change the server's hostname, you **must** use one of the following methods:\n * Use WHM's\n [*Change Hostname*](https://docs.cpanel.net/whm/networking-setup/change-hostname/)\n interface (*WHM >> Home >> Networking Setup >> Change Hostname*).\n * Call WHM API 1's `sethostname` function.\n * Run the\n [`/usr/local/cpanel/bin/set_hostname` utility](https://docs.cpanel.net/whm/scripts/the-set_hostname-utility/)\n as the `root` user.\nThese methods ensure that all of the necessary system and service changes occur.","operationId":"sethostname","parameters":[{"description":"The server's new hostname.\n\n**Important:**\n\nThe server's hostname should **never** be identical to the domain name. For example,\nif the domain is `example.com`, you could use a hostname such as `server1.example.com`,\nbut **not** `example.com`. ","in":"query","name":"hostname","required":true,"schema":{"example":"hostname.example.com","format":"hostname","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"sethostname","type":"string"},"output":{"description":"A list of the function's output.","properties":{"messages":{"description":"Any of the function's output messages.","example":"Updating cPanel license...Done. Update succeeded.","type":"string"},"warnings":{"description":"Any of the function's warnings.","example":"The hostname was already set to hostname.example.com, syncing configuration only.","type":"string"}},"type":"object"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Stopping cPHulkd during hostname change\nService “cphulkd” is already stopped.<br />\n<br />\n<span class='cpanel_output_color_bold'>Startup Log</span><br />\n <span class='cpanel_output_indent'></span><span class='cpanel_output_color_bold cpanel_output_ color_bright_yellow cpanel_output_color_on_grey6'>Warning: Journal has been rotated since unit was started. Log output is incomplete or unavailable.</span><br />\n<br />\n<span class= 'cpanel_output_color_bold okmsg'>cphulkd stopped successfully.</span><br />\nStopping MySQL during hostname change\nChanging hostname in kernel to hostname.example.com\nAltered hostname in /etc/sysconfig/network\nUpdating cPHulkd\nStarting cPHulkd\n(XID qju5cf) The “cphulkd” service is not configured.\nRestarting Exim\nWaiting for “exim” to restart ………waiting for “exim” to initialize ………finished.<br />\n<br />\n<span class='cpanel_output_color_bold'>Service Status</span><br />\n<span class='cpanel_output_indent'></span>exim (/usr/sbin/exim -ps -bd -q1h -oP /var/spool/exim/exim-daemon.pid) is running as mailnull with PID 16943 (systemd+/proc check method).<br />\n<br />\n<span class='cpanel_output_color_bold'>Startup Log</span><br />\n <span class='cpanel_output_indent'></span>Jul 29 15:03:14 hostname.example.com systemd[1]: Starting Exim is a Mail Transport Agent, which is the program that moves mail from one machine to another....<br />\n<span class='cpanel_output_indent'></span>Jul 29 15:03:14 hostname. example.com systemd[1]: Can't open PID file /var/spool/exim/exim-daemon.pid (yet?) after start: No such file or directory<br />\n<span class='cpanel_output_indent'></span>Jul 29 15:03:14 hostname.example.com systemd[1]: Started Exim is a Mail Transport Agent, which is the program that moves mail from one machine to another..<br />\n<br />\n<span class='cpanel_output_ color_bold'>Log Messages</span><br />\n<span class='cpanel_output_indent'></span>2020-07-29 15:03:14 exim 4.93 daemon started: pid=16943, -q1h, listening for SMTP on port 25 (IPv6 and IPv4) port 587 (IPv6 and IPv4) and for SMTPS on port 465 (IPv6 and IPv4)<br />\n<span class='cpanel_ output_indent'></span>2020-07-29 14:57:20 exim 4.93 daemon started: pid=16089, -q1h, listening for SMTP on port 25 (IPv6 and IPv4) port 587 (IPv6 and IPv4) and for SMTPS on port 465 (IPv6 and IPv4)<br />\n<br />\n<span class='cpanel_output_color_bold okmsg'>exim restarted successfully.</span><br />\nUpdating Apache configuration\nUpdating cPanel license...Done. Update succeeded.\nA DNS record already exists for “hostname.example.com”.\nThe system has queued the hostname changes for the DAV services.\nUsers cannot access the DAV features that use these services until\nthe system has finished updates to the hostname. After the system adjusts a\nspecific user’s database, it restores their access to the DAV services.\n\nYou will receive a notification when the system completes the update for all users.\nWaiting for “mysql” to start ……waiting for “mysql” to initialize ………finished.<br />\n<br />\n<span class='cpanel_output_color_bold'>Service Status</span><br />\n<span class='cpanel_output_indent'></span>mysqld (/usr/sbin/mysqld --daemonize --pid-file= /var/run/mysqld/mysqld.pid) is running as mysql with PID 16886 (systemd+/proc check method). <br />\n<br />\n<span class='cpanel_output_color_bold'>Startup Log</span><br />\n<span class= 'cpanel_output_indent'></span>Jul 29 15:03:10 hostname.example.com systemd[1]: Starting MySQL Server...<br />\n<span class='cpanel_output_indent'></span>Jul 29 15:03:11 hostname.example.com systemd[1]: Started MySQL Server.<br />\n<br />\n<span class='cpanel_output_color_bold'>Log Messages</span><br />\n<span class='cpanel_output_indent'></span>2020-07-29T20:03:11.894935Z 0 [Note] /usr/sbin/mysqld: ready for connections.<br />\n<span class='cpanel_output_indent'> </span>2020-07-29T20:03:09.442015Z 0 [Note] /usr/sbin/mysqld: Shutdown complete<br />\n<span class='cpanel_output_indent'></span>2020-07-29T19:57:17.010586Z 0 [Note] /usr/sbin/mysqld: ready for connections.<br />\n<br />\n<span class='cpanel_output_color_bold okmsg'>mysql started successfully.</span><br />","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update server's hostname","tags":["Server Administration","System Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n sethostname \\\n hostname='hostname.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/sethostname?api.version=1&hostname=hostname.example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/set_primary_servername":{"get":{"description":"This function sets the primary domain hosted on an IP address and web server port. The primary domain refers to the virtual host that the server returns when a visitor directly accesses the IP address.\n\nFor example, if both `example1.com` and `example2.com` are name-based virtual hosts on IP address `192.168.0.1`, the primary virtual host appears when the visitor accesses the `http://192.168.0.1/` location.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"set_primary_servername","parameters":[{"description":"The `ServerName` value in Apache's `VirtualHost` section to set as primary for the IP address and port type.","in":"query","name":"servername","required":true,"schema":{"example":"hostname.example.com","format":"domain","type":"string"}},{"description":"The type of virtual host to set as primary.\n* `std` — Set the primary domain for the HTTP port. Typically, port `80`.\n* `ssl` — Set the primary domain for the HTTPS port. Typically, port `443`.","in":"query","name":"type","required":false,"schema":{"default":"std","enum":["std","ssl"],"example":"std","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_primary_servername","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update server's primary virtual host","tags":["Server Administration","System Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_primary_servername \\\n servername='hostname.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_primary_servername?api.version=1&servername=hostname.example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/delete_hook":{"get":{"description":"This function removes a script hook.","operationId":"delete_hook","parameters":[{"description":"The script hook's ID.\n\n**Note:**\n\nTo retrieve a hook's ID, use the WHM API 1 `list_hooks` function.","in":"query","name":"id","required":true,"schema":{"example":"HzEpGvT6QGUYwxuX3hWB8AUq","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"delete_hook","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete script hook","tags":["Script Hooks","Scripts Hooks"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n delete_hook \\\n id='HzEpGvT6QGUYwxuX3hWB8AUq'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_hook?api.version=1&id=HzEpGvT6QGUYwxuX3hWB8AUq"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.32"}},"/reorder_hooks":{"get":{"description":"This function changes the order of script hooks.","operationId":"reorder_hooks","parameters":[{"description":"A comma-seprated list of script hook IDs, in order of priority.\n\n**Note:**\n\nTo retrieve a hook's ID, use the WHM API 1 `list_hooks` function.","in":"query","name":"ids","required":true,"schema":{"example":"HzEpGvT6QGUYwxuX3hWB8AUq,UNs8a8IbbAVf5oi_hXbcEw5a","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"hook_order":{"description":"A list of the script hook details.","example":[{"id":"HzEpGvT6QGUYwxuX3hWB8AUq","weight":100},{"id":"UNs8a8IbbAVf5oi_hXbcEw5a","weight":200}],"items":{"properties":{"id":{"description":"The script hook's ID.","example":"HzEpGvT6QGUYwxuX3hWB8AUq","type":"string"},"weight":{"description":"The script hook's weight. The lower the number, the greater the priority.","example":100,"minimum":1,"type":"integer"}},"type":"object"}}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"reorder_hooks","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update script hooks order","tags":["Script Hooks","Scripts Hooks"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n reorder_hooks \\\n ids='HzEpGvT6QGUYwxuX3hWB8AUq,UNs8a8IbbAVf5oi_hXbcEw5a'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/reorder_hooks?api.version=1&ids=HzEpGvT6QGUYwxuX3hWB8AUq%2cUNs8a8IbbAVf5oi_hXbcEw5a"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.32"}},"/ipv6_enable_account":{"get":{"description":"This function assigns an IPv6 address to one or more accounts.\n\n**Note:**\n\nYou **must** perform at least one of the following actions before you call this function:\n * Use WHM's [*IPv6 Ranges*](https://go.cpanel.net/whmdocsIPv6Ranges) interface (*WHM >> Home >> IP Functions >> IPv6 Ranges*) or WHM API 1's `ipv6_range_add` function to add one or more IPv6 address ranges for use as dedicated IPv6 addresses.\n * Use WHM's [*Basic WebHost Manager Setup*](https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup) interface (*WHM >> Home >> Server Configuration >> Basic WebHost Manager Setup*) or modify the [`/etc/wwwacct.conf`](https://go.cpanel.net/advancedinstall) file to add a shared IPv6 address to the server.\n * For all of cPanel & WHM's features to function properly on IPv6, the `cpsrvd` daemon **must** listen on IPv6 addresses. To enable this functionality, select *On* for the *Listen on IPv6 Addresses* setting in the *System* section of WHM's [*Tweak Settings*](https://go.cpanel.net/whmdocsTweakSettings#system) interface (*WHM >> Home >> Server Configuration >> Tweak Settings*).\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"ipv6_enable_account","parameters":[{"description":"A comma-delimited list of account names.","in":"query","name":"user","required":true,"schema":{"example":"user1,user2,user3","format":"username","type":"string"}},{"description":"The IPv6 address range's name.\n\n**Note:**\n\nThe range name `SHARED` will assign the server's shared IPv6 address to the account(s).","in":"query","name":"range","required":true,"schema":{"example":"Hosting_IPv6_Block","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"example":{"fail_cnt":2,"failures":{"brain":"The “brain” account does not exist.","pinky":"The “pinky” account does not exist."},"ipv6":{"chewie":"2001:0db8:1a34:56cf:0000:0000:0000:0000","cptest":"2001:0db8:1a34:56cf:0000:0000:0000:0001","domain1":"2001:0db8:1a34:56cf:0000:0000:0000:0002"}},"properties":{"fail_cnt":{"description":"The number of accounts that failed to enable IPv6.","example":0,"minimum":0,"type":"integer"},"failures":{"additionalProperties":{"description":"The account and the reason why IPv6 enable failed.\n\n**Note:**\n\nThe function uses the account name as the return's name.","example":"Failed to enable IPv6","type":"string"},"description":"List of accounts where IPv6 enable failed.","type":"object"},"ipv6":{"additionalProperties":{"description":"The account and the IPv6 address assigned to the account.\n\n**Note:**\n\nThe function uses the account name as the return's name.","type":"string"},"description":"The IPv6 addresses that the system assigned to each account.","type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"ipv6_enable_account","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add IPv6 address range to accounts","tags":["IP Addresses","IPv6 Address Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n ipv6_enable_account \\\n user='user1,user2,user3' \\\n range='Hosting_IPv6_Block'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ipv6_enable_account?api.version=1&user=user1%2cuser2%2cuser3&range=Hosting_IPv6_Block"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.40"}},"/ipv6_disable_account":{"get":{"description":"This function removes the IPv6 address from an account.\n\n**Notes:**\n\n- When you disable IPv6 on an account, the system unbinds that IPv6 address from your server and the account loses the address. If you enable IPv6 on that account again, the system assigns it a different IPv6 address.\n- For all of cPanel & WHM's features to function properly on IPv6, the `cpsrvd` daemon **must** listen on IPv6 addresses. To enable this functionality, select On for the *Listen on IPv6 Addresses* setting in the *System* section of WHM's [Tweak Settings](https://go.cpanel.net/whmdocsTweakSettings) interface (*WHM >> Home >> Server Configuration >> Tweak Settings*).\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"ipv6_disable_account","parameters":[{"description":"A comma delimited list of account names.","in":"query","name":"user","required":true,"schema":{"example":"user1,user2,user3","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"fail_cnt":{"description":"The number of accounts that failed to disable IPv6.\n\n**Note**\n\nThe function only returns this value if any failures exist.","example":0,"minimum":0,"type":"integer"},"failures":{"description":"List of accounts where IPv6 disable failed\n\n**Note**\n\nThe function only returns this value if any failures exist.","items":{"properties":{"name":{"description":"The name of the account where IPv6 disable failed","example":"user1","format":"username","type":"string"},"reason":{"description":"The reason for the IPv6 disable failure","example":"The “user1” account does not exist."}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"ipv6_disable_account","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove IPv6 address range from account","tags":["IP Addresses","IPv6 Address Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n ipv6_disable_account \\\n user='user1,user2,user3'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ipv6_disable_account?api.version=1&user=user1%2cuser2%2cuser3"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.40"}},"/ipv6_range_add":{"get":{"description":"This function adds a range of IPv6 addresses to the server.\n\n**Notes:**\n\n- This function **cannot** modify the server's shared IPv6 address. To update that address, modify the [/etc/wwwacct.conf](https://go.cpanel.net/advancedinstall) file, or use WHM's [*Basic WebHost Manager Setup*](https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup) interface (*Home >> Server Configuration >> Basic WebHost Manager Setup*).\n- For all of cPanel & WHM's features to function properly on IPv6, the `cpsrvd` daemon **must** listen on IPv6 addresses. To enable this functionality, select *On* for the *Listen on IPv6 Addresses* setting in the [*System*](https://go.cpanel.net/whmdocsTweakSettings#system) section of WHM's [*Tweak Settings*](https://go.cpanel.net/whmdocsTweakSettings) interface (*WHM >> Home >> Server Configuration >> Tweak Settings*).\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"ipv6_range_add","parameters":[{"description":"The IPv6 address range and network portion\nin [CIDR format](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).","in":"query","name":"range","required":true,"schema":{"example":"2001:db8:66ac:cafe::/64","type":"string"}},{"description":"The IPv6 address range's name.\n\n**Note:**\n\nYou **cannot** use SHARED as a range's name.\nIt is reserved for the server's shared IPv6 address.","in":"query","name":"name","required":true,"schema":{"example":"ExampleRange","type":"string"}},{"description":"Whether the IPv6 address range is available.\n\n**Note**\n\n* `1` - Available.\n* `0` - Reserved.","in":"query","name":"enabled","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"A note for the IPv6 address range.","in":"query","name":"note","required":false,"schema":{"default":null,"example":"Initial IPv6 address pool","nullable":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"ipv6_range_add","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add IPv6 address range","tags":["IP Addresses","IPv6 Address Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n ipv6_range_add \\\n range='2001:db8:66ac:cafe::/64' \\\n name='ExampleRange'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ipv6_range_add?api.version=1&range=2001%3adb8%3a66ac%3acafe%3a%3a%2f64&name=ExampleRange"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.40"}},"/ipv6_range_edit":{"get":{"description":"This function changes an IPv6 address range's name and/or note.\n\n**Notes:**\n\n- This function **cannot** modify the server's shared IPv6 address. To update that address, modify the [/etc/wwwacct.conf](https://go.cpanel.net/advancedinstall) file, or use WHM's [*Basic WebHost Manager Setup*](https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup) interface (*Home >> Server Configuration >> Basic WebHost Manager Setup*).\n- For all of cPanel & WHM's features to function properly on IPv6, the `cpsrvd` daemon **must** listen on IPv6 addresses. To enable this functionality, select *On* for the *Listen on IPv6 Addresses* setting in the [*System*](https://go.cpanel.net/whmdocsTweakSettings#system) section of WHM's [*Tweak Settings*](https://go.cpanel.net/whmdocsTweakSettings) interface (*WHM >> Home >> Server Configuration >> Tweak Settings*).\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"ipv6_range_edit","parameters":[{"description":"The IPv6 address range's current name.\n\n**Note:**\n\nYou **cannot** edit the range named SHARED.","in":"query","name":"name","required":true,"schema":{"example":"ExampleRange","type":"string"}},{"description":"The IPv6 address range's new name.\n\n**Note:**\n\n* If not supplied the range keeps its old name.\n* You **cannot** change range name to SHARED.","in":"query","name":"new_name","required":false,"schema":{"default":null,"example":"AnotherRange","type":"string"}},{"description":"The IPv6 address range's new note.\n\n**Note:**\n\nIf you don't specify this parameter, the function will not change the range's note.","in":"query","name":"note","required":false,"schema":{"default":null,"example":"This is an update to the note.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"ipv6_range_edit","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update IPv6 address range name or note","tags":["IP Addresses","IPv6 Address Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n ipv6_range_edit \\\n name='ExampleRange'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ipv6_range_edit?api.version=1&name=ExampleRange"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.40"}},"/ipv6_range_usage":{"get":{"description":"This function retrieves usage information for IPv6 addresses in an IPv6 range.\n\n**Note:**\n\nFor all of cPanel & WHM's features to function properly on IPv6, the `cpsrvd` daemon **must** listen on IPv6 addresses. To enable this functionality, select *On* for the *Listen on IPv6 Addresses* setting in the [*System*](https://go.cpanel.net/whmdocsTweakSettings#system) section of WHM's [*Tweak Settings*](https://go.cpanel.net/whmdocsTweakSettings) interface (*WHM >> Home >> Server Configuration >> Tweak Settings*).\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"ipv6_range_usage","parameters":[{"description":"The IPv6 address range's name.","in":"query","name":"name","required":true,"schema":{"example":"TestRange","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"usage":{"description":"The IPv6 address range's information.","properties":{"forbidden":{"description":"The number of reserved IPv6 addresses.","example":65536,"minimum":0,"type":"integer"},"free":{"description":"The number of available IPv6 addresses.","example":1000000,"minimum":0,"type":"integer"},"used":{"description":"The number of assigned IPv6 addresses.","example":20,"minimum":0,"type":"integer"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"ipv6_range_usage","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return IPv6 address usage","tags":["IP Addresses","IPv6 Address Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n ipv6_range_usage \\\n name='TestRange'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ipv6_range_usage?api.version=1&name=TestRange"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.40"}},"/ipv6_range_list":{"get":{"description":"This function lists available IPv6 address ranges.\n\n**Note:**\n\nFor all of cPanel & WHM's features to function properly on IPv6, the `cpsrvd` daemon **must** listen on IPv6 addresses. To enable this functionality, select *On* for the *Listen on IPv6 Addresses* setting in the [*System*](https://go.cpanel.net/whmdocsTweakSettings#system) section of WHM's [*Tweak Settings*](https://go.cpanel.net/whmdocsTweakSettings) interface (*WHM >> Home >> Server Configuration >> Tweak Settings*).\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"ipv6_range_list","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"range":{"description":"An array of the IPv6 address ranges.","items":{"properties":{"CIDR":{"description":"The IPv6 address range, in CIDR format.","example":"2001:db8:100:6::/64","type":"string"},"enabled":{"description":"Whether the IPv6 address range is available.\n* `1` Available.\n* `0` Reserved.","enum":[0,1],"example":1,"type":"integer"},"first":{"description":"The first IPv6 address in the range.","example":"2001:db8:0100:0006:0000:0000:0000:0000","format":"ipv6","type":"string"},"last":{"description":"The last IPv6 address in the range.","example":"2001:db8:0100:0006:ffff:ffff:ffff:ffff","format":"ipv6","type":"string"},"mostrecent":{"description":"The most recently assigned address from the IPv6 address range.","example":"2001:db8:0100:0006:0000:0000:0002:00ce","format":"ipv6","type":"string"},"name":{"description":"The IPv6 address range's name.\n\n**Note:**\n\n`SHARED` represents the server's main IPv6 address.","example":"test_range","type":"string"},"note":{"description":"The IPv6 address range's note.","example":"This is used for development.","type":"string"},"owner":{"description":"The user who owns the IPv6 address range.","example":"root","format":"username","type":"string"},"range_users":{"description":"The user or users who use addresses in the IPv6 address range.","items":{"example":"user1","format":"username","type":"string"},"type":"array"},"reclaimed":{"description":"IPv6 addresses within the range which have become available.","items":{"example":"2001:db8:0100:0006:0000:0000:0000:0002","format":"ipv6","type":"string"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"ipv6_range_list","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return available IPv6 address ranges","tags":["IP Addresses","IPv6 Address Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n ipv6_range_list\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ipv6_range_list?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.40"}},"/ipv6_range_remove":{"get":{"description":"This function removes an IPv6 address range from the server.\n\n**Note:**\n\n* This function **cannot** modify the server's shared IPv6 address. To update that address, modify [the `/etc/wwwacct.conf` file](https://go.cpanel.net/advancedinstall), or use WHM's [_Basic WebHost Manager Setup_](https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup) interface (_Home >> Server Configuration >> Basic WebHost Manager Setup_).\n* For all of cPanel & WHM's features to function properly on IPv6, the `cpsrvd` daemon **must** listen on IPv6 addresses. To enable this functionality, select _On_ for the _Listen on IPv6 Addresses_ setting in the _System_ section of WHM's [_Tweak Settings_](https://go.cpanel.net/whmdocsTweakSettings) interface (_WHM >> Home >> Server Configuration >> Tweak Settings_).\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"ipv6_range_remove","parameters":[{"description":"The IPv6 address range's name.","in":"query","name":"name","required":true,"schema":{"example":"Range1","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"ipv6_range_remove","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove IPv6 address range","tags":["IP Addresses","IPv6 Address Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n ipv6_range_remove \\\n name='Range1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/ipv6_range_remove?api.version=1&name=Range1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.40"}},"/create_integration_group":{"get":{"description":"This function creates a group to store integrations links in the cPanel interface.","operationId":"create_integration_group","parameters":[{"description":"The cPanel account name.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The group's ID within the system.\n\n**Warning:**\n\n If you create a link with a `group_id` value that already exists, the function replaces the existing group with the newly-created group.","in":"query","name":"group_id","required":true,"schema":{"example":"WHMCS","type":"string"}},{"description":"The label for the group to display in the cPanel interface.","in":"query","name":"label","required":true,"schema":{"example":"WHMCS+Control","type":"string"}},{"description":"The order in which to display the group in the cPanel interface.\n\n**Note:**\n\n By default, the function will automatically create an item under the username menu in the interface header.","in":"query","name":"order","required":true,"schema":{"example":1,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"create_integration_group","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Ok","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create integration link group","tags":["Integration","Links"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n create_integration_group \\\n user='username' \\\n group_id='WHMCS' \\\n label='WHMCS+Control' \\\n order='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/create_integration_group?api.version=1&user=username&group_id=WHMCS&label=WHMCS%2bControl&order=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/create_integration_link":{"get":{"description":"This function creates an integration link in the cPanel interface.\n\n**Note:**\n\nThe function creates the `APP.adminconfig` and `APP.userconfig` integration link files in the `/var/cpanel/integration/links/USERNAME` directory, where `APP` represents the application name and `USERNAME` represents the user for whom you create integration links.","operationId":"create_integration_link","parameters":[{"description":"The cPanel account name.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The application to link.\n\n**Note:**\n* If you create a link with an `app` value that already exists, the function will replace the existing link with the newly-created link.\n* The value you assign to the `app` parameter is how you identify that integration link when listing or removing integration links.\n* You may include underscore (`_`) characters.","in":"query","name":"app","required":true,"schema":{"example":"WHMCS_billing","type":"string"}},{"description":"The token that the system will present to the URL in the `autologin_token_url` endpoint.","in":"query","name":"token","required":true,"schema":{"example":"subway","type":"string"}},{"description":"The service for which to implement authentication.\n\n**Note:**\n\nThis is a string from the `get_users_links` function. The function typically returns one of the following values.\n\n* `billing` - This link appears in the user menu\n* `customer_service` - This link appears in the user menu\n* `support` - This link appears in the user menu\n* `upgrade` - This link appears in the user menu and context-sensitive areas when the user may require more of a resource","in":"query","name":"implements","required":true,"schema":{"example":"billing","type":"string"}},{"description":"The label to display in the cPanel login interface.","in":"query","name":"label","required":true,"schema":{"example":"WHMCS Billing","type":"string"}},{"description":"The subscriber's unique ID that the system will present to the URL in the `autologin_token_url` endpoint.","in":"query","name":"subscriber_unique_id","required":true,"schema":{"example":"1234","type":"string"}},{"description":"The URL to which the server will send the `app`, `token`, `user`, and `subscriber_unique_id` values through an `HTTP POST` request. The destination server will respond with a JSON-encoded object with either a `redirect_url` key or the `retry` and `attempt` keys.\n\n**Note:**\n\n* You **must** include either the `autologin_token_url` parameter, the `url` parameter, or both.\n* If you do not set the `autologin_token_url` parameter, or that server does not respond or exist, then the server will redirect the user to the location in the `url` parameter.\n* If the response contains `redirect_url`, the system will redirect the user to that URL. (For example:, `{\"redirect_url\":\" http://www.whmcs.com/client_area/login/?one_time_user_token_that_expires_in_120_seconds=d41d8cd98f00 ”}` will send the user to that unique URL.)\n* If the response contains `retry` and `attempt`, the system will wait for the retry value in seconds for a maximum of 60 seconds and then attempt the call again. The attempt value indicates the number of attempts that your system has tried. The system will stop after three attempts. (For example, `{\"retry\":30, \"attempt\":2}` represents the second attempt to connect, and the system will pause the user for 30 seconds before it tries again.)","in":"query","name":"autologin_token_url","required":false,"schema":{"example":"http://www.example.com/login.cgi","format":"json","type":"string"}},{"description":"The URL to which to send the user if the `autologin_token_url` location does not respond or is not present.\n\n**Note:**\n\n* You **must** include either the `autologin_token_url` parameter, the `url` parameter, or both.","in":"query","name":"url","required":false,"schema":{"example":"http://www.example.com","format":"url","type":"string"}},{"description":"The icon image.\n\n**Note:**\n\nIf you **do not** specify a value, the interface uses a standard puzzle piece icon.","in":"query","name":"base64_png_image","required":false,"schema":{"example":"iVBORw0KGgoAAAANSUhEUgAAAJgAAADYCAYAAA AXmipNAAAACXBIWXMAAALVAAAC1QHAwm8lAAAAGXRFWHRTb2Z0d2FyZQB 3d3cuaW5rc2NhcGUub3Jnm+48GgAAAUNJREFUeJztziFKg2EABuD3+ydz qGBwiGBZ385hstoMu4DNA8w7eIuBRUyWBYvJsC6CYWCwGGSy7bN6AOFn8 DwneJI/6mTYreNBryYl8A9KktTxoJfu0W66y3mSw6Q8pD+/LJNsWv6x5Z p6NbzJ/sF7uj/3Sf3OJqPUep6P0WnbObZfk1qu02zOks0spXylk+eUvOS 4v2g7x/bbSamPSecuqZ+p5TbN6inLvbcyma3azrH9Sr1IJyejQcq6yWL0 WqbTddspAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AANr0C5EmMYv5JZrpAAAAAElFTkSuQmCC","format":"base64 image","type":"string"}},{"description":"The order in which to display the icon in the cPanel interface inside the `group_id` group.","in":"query","name":"order","required":false,"schema":{"example":"999","type":"string"}},{"description":"The group ID in which to add the icon of the linked service.\n\n* `files`\n* `databases`\n* `domains`\n* `email`\n* `metrics`\n* `security`\n* `software`\n* `advanced`\n* `pref`\n\n**Note:**\n\nIf you **do not** specify a value, the function automatically creates an item under the username menu in the interface header.","in":"query","name":"group_id","required":false,"schema":{"enum":["files","databases","domains","email","metrics","security","software","advanced","pref"],"example":"advanced","type":"string"}},{"description":"Whether the cPanel interface will display the integration link.\n\n * `1` - Do **not** display the link.\n * `0` - Display the link.","in":"query","name":"hide","schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"create_integration_link","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Ok","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create integration link","tags":["Integration","Links"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n create_integration_link \\\n user='username' \\\n app='WHMCS_billing' \\\n token='subway' \\\n implements='billing' \\\n label='WHMCS Billing' \\\n subscriber_unique_id='1234'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/create_integration_link?api.version=1&user=username&app=WHMCS_billing&token=subway&implements=billing&label=WHMCS%20Billing&subscriber_unique_id=1234"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/get_integration_link_user_config":{"get":{"description":"This function retrieves configuration information about a specified integration link in a specified user's cPanel interface.","operationId":"get_integration_link_user_config","parameters":[{"description":"The cPanel account name.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The integration link's app name.\n\n**Warning:**\n\nIf you create a link with an app value that already exists, the function will replace the existing link with the newly-created link.","in":"query","name":"app","required":true,"schema":{"example":"WHMCS_billing","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"userconfig":{"description":"An object with information about the user's integration link.","properties":{"app":{"description":"The application to link.","example":"WHMCS_billing","type":"string"},"autologin_token_url":{"description":"A publicly-available URL to which the server will send the\n`app`, `token`, `user`, and `subscriber_unique_id` values through\nan HTTP POST request. The destination server will respond\nwith a JSON-encoded object with either a `redirect_url`\nkey or the `retry` and `attempt` keys.\n\n* If the response contains `redirect_url`, the system will redirect\nthe user to that URL (for example, `{\"redirect_url\":\"http://www.whmcs.com/client_area/login/?one_time_user_token_that_expires_in_120_seconds=d41d8cd98f00}`\nwill send the user to that URL).\n* If the response contains `retry` and `attempt`, the system will wait for\nthe `retry` value in seconds for a maximum of 60 seconds\nand then attempt the call again. The `attempt` value indicates\nthe number of attempts that the system tried. The system\nwill stop after three attempts (for example, `{\"retry\":30,\n\"attempt\":2}` represents the second attempt to connect,\nand the system will pause the user for 30 seconds before\nit tries again).","example":"http://www.example.com/login.cgi","format":"url","type":"string"},"base64_png_image":{"description":"The image to display for the application on the cPanel *Home* interface.","example":"iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABmJLR0QA%2fwD%2fAP%2bgvaeTAAAACXBIWXMAAABIAAAASABGyWs%2bAAALVUlEQVRo3sWZe3BU1R3HP79z793dZAPkBYIg4RUSBKkIEfCNog5WbaWOHevUWttOVXxVtFWctmpb2xGptVOt1ken1bbSVsVSxVba8UkrsRIxYhbRJEqRVxJCErK7d%2b89%2fePcTW6WTdj4mH5nLuTunj3n%2b%2f2d3%2fn9fucc4f%2bAbdu2ISJkMhmxbXupiMwH0lrr33qet7W6uhoRKaivwlp9TCQSCQAFVAEdwL7gqxLgCeB0wAOuSqVSvywvLyeZTIrWeqLWukdrvVcpRXV19UF9q0%2bbeEC%2bEvgOsA74EVAaNBkP1AR%2fW0BdNBq1enp68Dyvzvf9P2qtVwNn%2bb5vh%2frrg%2f1JEP3hG0ehROFpt8qW2CLAymRceax7aXeHv2PtFSM3LtD4NwNxYAqQAn4CnAwcFupqLjADiAG%2fAOqCz2PAq0Bb7tjDFrC8Pj7gfVVdD%2b3p9xAUoJcCKzGuKUCHhWyPSWmiV7fvCQQ4wGXAKcAEIBrqbibweMBrSujzt4HOfHwKEhAiXR5YqQHYs6quJ%2fSdHwGOxbgCGg8NZQp7zhGxyvu39rY3AJOCxkXAnDxDWcD0nM9c4AUgA1BTUzPgyyEFhIhHgcXA1cBC4DHgxuX18fZQ89HALNBEZRRTnDPo8rdLt79r4aaelx%2bLqzHJ%2fKMIAmjo%2bzePAA8oBiYlEok6YNf06dP%2f1tTUpAeNQiHyDnAT8C36F18G%2bBWwgv6pPQVYo9GjjopcxMLYcjxSpPzO9mI1%2bg1BzQ9IBLQVGk1ad%2bFyAIfiroiUKIyb5aIFeAeoBQ4HtsZisQs6OzsbC3EhDUwMkc%2fO3DeAJPCDYOoXa%2fTImIximrMECxtBcFRRuUYvClscNHu8LWxzn2Gn9wZJ3ZGptI788ZLiu193de%2fZwNKAaBaT6Hc%2fgFrP886ePXt2YyEzAPAV4EEOdrle4EWgDBM9RgiKGudc5seuJSalaPwca3i8nX6CTakH6dY7s6J2CNaSmJRtvnjEehs4HrgDs6YOgoisi0QiV2%2fdunXboHlgVV1P%2bPU1YGeeZkXAmcFAIwxBnyZ3DRuSK%2bnVbYRzpSAk3LX8O3UX3XoXgpV93qpQ1c0%2bKTDu%2bQJwObAlD%2flnIpHIsmQyuW3u3LkFJ7IWYHMhDTUaH49t7jr2eFtQwRCCYp%2ffQkPqYVx9IAi7Bgr7lRV7NnWNsWbj6TTj7em0%2bTteV9h3YnJGFp7jOGu6urqaa2trqaioMC4RcpdRmOy4HeiiPyz0AE3AWUORFxRFUspIdQSHWUdTYdUOcKGWzPN0%2bu8PII9xwzevLIe4jOXp3m8y0T3Bakg9UjbZXtxyYtGN7yjsWUFby%2fO8C%2bPx%2bIetra2NjuPsskPkFbAMuCIg%2b0rwvAXMAs4e2vI%2bY61jOD72bUaq8ThS0jcjAB5pdmU2o9G5BVjMx%2f16qapqas48l3b1gTm7M1tO8MksTLhrKqY4i9RE%2b8Q%2bQ3iet8jzvAWu625Pp9OvhRflvMDvxgfPqYHlWzERaPyhXKdYjabCmg6hyJ6dG1%2b7JPW%2bfNWjAGcmdftUjW8D4zV%2b1PTp0eE36ypOys0QRUC17%2fsVWQGxgPyEnI5LMOn9UOgE%2fVpMStuA00GPYkChqBGxsCWGJm8JrDR%2bbgZGUDgUDRYpXRFpywqIMzDuFooU8HfgXl%2b7G%2bZELvFdfWCuEmeuhXMccAZBdLKJUmnVpj7IvGwTlBtDQ%2bNInDJrygDrK6UaReRZy7I2KaW2ZK3Uhil3XxkG%2bX3AbcDFwLO2FO0%2fZsZJ3TEpewH4KfA1TAUZ0IGZkS82l8i4J0GnDtW5j88Y6ygqVE04EHiWZd3V2Nh4w6RJk35fVVXVoELxvgFTJb5QAPku4LuYynPfqrqeUN7QaDIIMh0YF7ZoiYydtLTkd42C%2fQDozOC29ymSCj4T%2bTIRKSG0nsTzvCPr6upKWltb0VobPw2JaAxE%2fHNI48B9wAOAm%2f3t9fUjeP6tPzDtzclYRI7TcD8560fjx4pl9GXnl6xuUTjrNV6YXF8OKZZKFsSu1RPs43IzufJ9%2f8re3t7bo9FoZSKR6F9oIRFNwBoGKQ2BTZjNxkFuMNk5jddnvlSpsG8Hna9cRuOPLVfTVpxVfE%2fZYdacdERGoLBROMRlNNOcM1lcfAc1zrmDLd6o53lX9Pb2XlpbW9tf24TyQTFwDPn3yz7wKPB%2bvp5TuoudXkPnFLV4k6BODozQhalYD6dvr%2bCXH24fO3%2bJVUOn%2fz69ug2Fwwg1jhFqAjbRXMt3iUiH1nosEBGRNqVU%2fcaNG5Hl9fEYZltXGxA%2fFrPVK8vDcTsmG7%2bZM2sALNsIN5R%2bSI%2b%2fZ5otsZtAvw%2b8hAkSq4DTBnYnCKrPUjpwoly7AN%2bLRCJPicg8z%2fNOFZF3y8rKVrqu69qYzUktJgcUM%2fRJxTuYxJYXcSmlyhlLqyvveiQvd%2fUBV7B0YPn%2f5nOoYOc2FHwgkU6nE8XFxYnKysrVqVRK2tra3KlTp2IDn6NwbMdk57y4o24fdxj9GkiHThAOx2T6MKn99O%2bRw%2bgJfl8SvBcBJ6TT6adEhO7u7syMGTP6Gis4lAEGoBuzvRsuZjFwQ%2fIc8HngZwR73QCtwCWYemxH6PP5kUikVGt90IGXzfAOt%2bIYdxiuiGbMmdASTHK7CuOOXZjN0pigXT2wVpC0RvuYdeMCT5Mn6mUFPI5ZAxMx0zaUoAmBiP3DFNAEXIoJDu8ET9bi74UEbBypJqT2egksia62sHcL0pEhtUlQnq0ieQVchDlRqMEcmdRhKtHyPESmB0IbC2GdcwSyH1gL0JRoQuOhsDs87f4ZdA%2bQFFEvZnSKh%2fefxF3HdmcwrjYk%2bqwdygNFwD3AV%2fO094DrgJ9nP8gNpYXipS2rcaSSlL%2fbsSTiaLT2dCoF%2bKfMvKjgfga4S0jEVcDd5HenesypwfaPI%2bCTQr5MfGRAcLC1MBezc%2fs%2bkB7ugME45cA5mFI7XxQUTPZ%2bGmgfylCSQ%2f4oTJ1z0iF47MeU3w8CmUJnIRhnJHArJlQ6Qwhwgd8IskKj9w4qIET%2bGIxvH1%2bgMTswJ8z3BYIGtVJojAnAzZiIFDnkCCZHPGpJ0Y31bXt33bdgPdUjF6Gkfz%2bUFVABrOagWuWQSAHPAPdi4ntXWEjQt2DuB04HrgTmM7x7CQ1q5Sljr1nx2t5HvFuObkak%2f%2bfZNdCFSTbDRRQ4D3MuWo%2fZ0TUtr493BsRHA7OBE4P%2fiz7CGK4Sq%2fmcv%2f7Qe%2bi089F6oMeFXWgeJqlN7FdONybRlGKuhwpBOngkEFjI%2bauHOYWLBOPEQuZ%2fTkn0wm63ve3eBT5KBk5euPP%2fYBbwMsyFwobgacTUMvfQfx00FCIU5t8hjqwFrg%2bEzMGsw4VAhSCrtN7fticJuw%2b0HPTj3Cg0ArOP3UF%2fVZjFncDyYRArFL2YauBJgJHOOErs0WpncktZxu%2bt8NEtvs6kF429lqVVd%2bUXMBhCwuLAnzDF2KeBW4Fbsi%2fDSY6FRoPJmEX4aeF4gvOj4WJQATn3A%2fMYeJuYRS%2bmTP4XQ1eouzAHYBvg4D0jJvtPBgbE%2bI8lIAQbk5lzo0kaE%2f8vBD6LqZ3yZdVOTNY9D%2bPr6%2fK0OYxBLjM%2bCQGCCaXhCz0XE5VuCwh2AP8g%2fyy0YCx%2fIPj7GmB9TptmYI8Su%2b80%2b2MLCC0kF3Pd8yVMcbUfeAiz8MKEtwEf5OmqAdgben8XU%2b0%2bD%2bzGXBZ%2bAfiLr93gzrJwFNQ6tB7KMHF6M7B34D0xEeDXgdAs%2fIDsvVmjhNpXY0qYTUDqo5blw72p7yB07Li8Ps6quh6uqy9GUGngVQ0X0D%2bz7YJuAOk77wkRDW8tPzIKEnAo60RVORErhq%2b9dUrsKIgjIL722l0%2fucVSDh2pDwoZatj4H%2bRdIAdHBVWZAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDE1LTA5LTAyVDEyOjM5OjQ4LTA1OjAwppVa9QAAACV0RVh0ZGF0ZTptb2RpZnkAMjAxNS0wOS0wMlQxMjozOTo0OC0wNTowMNfI4kkAAAAASUVORK5CYII%3d","format":"base64 image","type":"string"},"implements":{"description":"The service for which to implement authentication. The `implements` value is a string from the WHM API 1 `get_users_links` function. Typically, this function returns one of the following values:\n* `billing` — This link appears in the user menu.\n* `customer_service` — This link appears in the user menu.\n* `support` — This link appears in the user menu.\n* `upgrade` — This link appears in the user menu and context-sensitive areas when the user may require more of a resource.","example":"billing","type":"string"},"label":{"description":"The label to display for the application on the cPanel *Home* interface.","example":"WHMCS Billing","type":"string"},"subscriber_unique_id":{"description":"The subscriber's unique ID that the system will present to the URL in the `autologin_token_url` endpoint.","example":"1234","type":"string"},"url":{"description":"A publicly-available URL to which to send the user if the\nlocation in the `autologin_token_url` parameter does not\nrespond.","example":"http://www.example.com","format":"url","type":"string"},"user":{"description":"The cPanel account name.","example":"username","format":"username","type":"string"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_integration_link_user_config","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return integration link configuration","tags":["Integration","Links"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_integration_link_user_config \\\n user='username' \\\n app='WHMCS_billing'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_integration_link_user_config?api.version=1&user=username&app=WHMCS_billing"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/list_integration_groups":{"get":{"description":"This function lists the groups of integration links in the cPanel interface.","operationId":"list_integration_groups","parameters":[{"description":"The cPanel account name.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"links":{"description":"An array of objects that contain the integration link groups.","items":{"properties":{"group":{"description":"The group ID.","example":"Group3","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_integration_groups","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return integration link groups","tags":["Integration","Links"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_integration_groups \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_integration_groups?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/list_integration_links":{"get":{"description":"This function lists integration links in the cPanel interface.","operationId":"list_integration_links","parameters":[{"description":"The cPanel account name.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"links":{"description":"An array of objects that contain information about the integration links.","items":{"properties":{"app":{"description":"The integration link's app name.","example":"WHMCS_billing","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_integration_links","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return integration links","tags":["Integration","Links"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_integration_links \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_integration_links?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/remove_integration_group":{"get":{"description":"This removes a group of integration links from the cPanel interface.","operationId":"remove_integration_group","parameters":[{"description":"The cPanel account name.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The group's ID.","in":"query","name":"group_id","required":true,"schema":{"example":"WHMCS","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{},"metadata":{"properties":{"command":{"description":"The method name called.","example":"remove_integration_group","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Ok","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove integration link group","tags":["Integration","Links"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n remove_integration_group \\\n user='username' \\\n group_id='WHMCS'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remove_integration_group?api.version=1&user=username&group_id=WHMCS"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/remove_integration_link":{"get":{"description":"This function removes an integration link from the cPanel interface.","operationId":"remove_integration_link","parameters":[{"description":"The cPanel account name.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The name of the integration link to remove.","in":"query","name":"app","required":true,"schema":{"example":"WHMCS_billing","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{},"metadata":{"properties":{"command":{"description":"The method name called.","example":"remove_integration_link","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Ok","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove integration link","tags":["Integration","Links"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n remove_integration_link \\\n user='username' \\\n app='WHMCS_billing'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remove_integration_link?api.version=1&user=username&app=WHMCS_billing"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/addips":{"get":{"description":"This function adds an IPv4 address or addresses to the server.\nWhen you add an IP address, the system attempts to add an alias of that IP\naddress to the main network interface. This process rebuilds the IP address\npool, which resides in the `/etc/ipaddrpool` file. The system stores IP addresses\nwithin the `/etc/ips` file. The `ipaliases` service activates those IP addresses\nwhen the server starts.","operationId":"addips","parameters":[{"description":"The IPv4 address or address range\nin [Class C CIDR format](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).","examples":{"ipv4":{"summary":"IPv4 address","value":"192.168.0.0"},"ipv4range":{"summary":"IPv4 address range","value":"192.168.0.20/28"}},"in":"query","name":"ips","required":true,"schema":{"type":"string"}},{"description":"The IPv4 address' netmask.\n\n**Note:**\n\nIf the `ips` parameter is in Class C CIDR format,\nthe range mask **must** be a value from `24` through `30`.","in":"query","name":"netmask","required":true,"schema":{"example":"255.255.255.0","format":"ipv4","type":"string"}},{"description":"An IPv4 address or comma-delimited list of IPv4 addresses to exclude.\n\n**Note:**\n\nIf you do not specify a value,\nthe function does not exclude any IPv4 addresses.","examples":{"multiple":{"summary":"Multiple IP addresses.","value":"excludes=192.0.20.0,192.0.20.1"},"single":{"summary":"A single IP address.","value":"192.0.20.0"}},"explode":false,"in":"query","name":"excludes","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"addips","type":"string"},"output":{"properties":{"messages":{"description":"A list of messages returned from the function.","items":{"example":"eth0:cp1 is now up. 192.168.0.20/255.255.255.0 broadcast 192.168.0.255 has been added.","type":"string"},"type":"array"}},"type":"object"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"Success","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add IP addresses","tags":["IP Addresses","IPv4 Address Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n addips \\\n ips='192.168.0.0' \\\n netmask='255.255.255.0'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/addips?api.version=1&ips=192.168.0.0&netmask=255.255.255.0"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/delip":{"get":{"description":"This function removes an IP address from the server.","operationId":"delip","parameters":[{"description":"The IPv4 address.","in":"query","name":"ip","required":true,"schema":{"example":"10.1.1.1","format":"ipv4","type":"string"}},{"description":"The network alias to which the IPv4 address is bound.","in":"query","name":"ethernetdev","required":false,"schema":{"default":"","example":"eth0","nullable":true,"type":"string"}},{"description":"Whether to remove the IP address if the ethernet interface is down.\n* `1` — Do **not** remove the IP address.\n* `0` — Remove the IP address.","in":"query","name":"skipifshutdown","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"delip","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"eth0:cp2 is now down, 10.1.1.1 has been removed","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove IP address","tags":["IP Addresses","IPv4 Address Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n delip \\\n ip='10.1.1.1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/delip?api.version=1&ip=10.1.1.1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/update_integration_link_token":{"get":{"description":"This function refreshes the token for an integration link.","operationId":"update_integration_link_token","parameters":[{"description":"The cPanel account name.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}},{"description":"The name of the application to link.\n\n**Note:**\n\n To update the name of the application in the interface, you **must** delete it and then recreate it with WHM API 1's `create_integration_link` function.","in":"query","name":"app","required":true,"schema":{"example":"WHMCS_billing","type":"string"}},{"description":"The new access token to use for the application.","in":"query","name":"token","required":true,"schema":{"example":"subway","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{},"metadata":{"properties":{"command":{"description":"The method name called.","example":"update_integration_link_token","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Ok","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update integration link token","tags":["Integration","Links"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n update_integration_link_token \\\n user='username' \\\n app='WHMCS_billing' \\\n token='subway'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/update_integration_link_token?api.version=1&user=username&app=WHMCS_billing&token=subway"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/get_public_ip":{"get":{"description":"This function returns the public IP address for a specified public or private IP address. You can use this function to determine the system's main public IP address, especially for [systems that use a 1:1 NAT configuration](https://go.cpanel.net/11NAT).\n* cPanel & WHM uses the main public IP address to perform many different functions. For example, the system uses this IP address to verify the server's license status with WebPros International, LLC.\n* System administrators can configure the main public IP address in WHM's [Basic WebHost Manager Setup](https://go.cpanel.net/whmdocsBasicasisWebHostManagerSetup) interface (_Home >> Server Configuration >> Basic WebHost Manager Setup_).","operationId":"get_public_ip","parameters":[{"description":"A valid public or private IP address to query.","in":"query","name":"ip","required":true,"schema":{"example":"192.0.2.0","format":"ipv4","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"public_ip":{"description":"The public IP address.","example":"192.0.2.0","format":"ipv4","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_public_ip","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return public IP address of private IP address","tags":["IP Addresses","Network Address Translation"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_public_ip \\\n ip='192.0.2.0'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_public_ip?api.version=1&ip=192.0.2.0"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"62"}},"/get_shared_ip":{"get":{"description":"This function retrieves the IP address that an account shares with the accounts that it owns.","operationId":"get_shared_ip","parameters":[{"description":"The WHM user's username.\n\n**Note:**\n\nThis parameter defaults to the currently-authenticated user.","in":"query","name":"user","required":false,"schema":{"example":"example","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"ip":{"description":"The IP address that the WHM user shares.\n\n**Note:**\n\n If the user does **not** have a shared IP address, the function returns the tilde ( `~` ) character.","example":"192.168.0.1","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_shared_ip","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return shared IP address","tags":["IP Addresses","IPv4 Address Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_shared_ip\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_shared_ip?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"62"}},"/listips":{"get":{"description":"This function lists a server's IP addresses.","operationId":"listips","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"ip":{"description":"An array of objects that contain IP address information.","items":{"properties":{"active":{"description":"Whether the IP address is active.\n* `1` — Active.\n* `0` — Inactive.","enum":[0,1],"example":1,"type":"integer"},"dedicated":{"description":"Whether the IP address is dedicated.\n* `1` — Dedicated.\n* `0` — Shared.","enum":[0,1],"example":0,"type":"integer"},"if":{"description":"The IP address' network interface.","example":"eth0","type":"string"},"ip":{"description":"The IP address.","example":"192.168.0.20","format":"ipv4","type":"string"},"mainaddr":{"description":"Whether the IP address is the server's main IP address.\n* `1` — Main IP address.\n* `0` — **Not** the main IP address.","enum":[0,1],"example":0,"type":"integer"},"netmask":{"description":"The IP address' netmask.","example":"255.255.0.0","format":"ipv4","type":"string"},"network":{"description":"The IP address' network value.","example":"192.168.0.0","format":"ipv4","type":"string"},"public_ip":{"description":"The public IP for the IP address.","example":"10.1.32.177","format":"ipv4","type":"string"},"removable":{"description":"Whether the IP address can be removed.\n* `1` — Removable.\n* `0` — **Not** removable.","enum":[0,1],"example":0,"type":"integer"},"used":{"description":"Whether the IP address is in use.\n* `1` — In use.\n* `0` — **Not** in use.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"listips","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return server's IP addresses","tags":["IP Addresses","IPv4 Address Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n listips\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/listips?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/suspend_outgoing_email":{"get":{"description":"This function sets Exim's queue to suspend and force failure for email that a user sends to an external address.\n\n**Note:**\n\n If mail for a cPanel user's account is suspended, the system will reject their email before the mail server puts it in queue.","operationId":"suspend_outgoing_email","parameters":[{"description":"The cPanel account.\n\n**Note**\n\nYou **cannot** suspend the `root` user's outgoing email with this function.","in":"query","name":"user","required":true,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"suspend_outgoing_email","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Suspend cPanel account outgoing email","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n suspend_outgoing_email \\\n user='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/suspend_outgoing_email?api.version=1&user=example"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/expunge_messages_for_mailbox_guid":{"get":{"description":"This function removes mail messages from a cPanel account.\n\n**Important:**\n\n When you disable the [Receive Mail role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"expunge_messages_for_mailbox_guid","parameters":[{"description":"The email account's name.","in":"query","name":"account","required":true,"schema":{"example":"user@example.com","type":"string"}},{"description":"The mailbox's globally unique identifier (GUID).\n\n**Note:**\n\nTo find the mailbox GUID, use the WHM API 1 - `get_mailbox_status` function.","in":"query","name":"mailbox_guid","required":true,"schema":{"example":"2550860f0c58d158c92a000044f0d230","type":"string"}},{"description":"The Dovecot search query to select which messages you wish to remove from the mailbox. For more information, read [Dovecot's Search Query](http://wiki2.dovecot.org/Tools/Doveadm/SearchQuery) documentation.","in":"query","name":"query","required":true,"schema":{"example":"savedbefore 52w","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"expunge_messages_for_mailbox_guid","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove email account messages by mailbox GUID","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n expunge_messages_for_mailbox_guid \\\n account='user@example.com' \\\n mailbox_guid='2550860f0c58d158c92a000044f0d230' \\\n query='savedbefore 52w'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/expunge_messages_for_mailbox_guid?api.version=1&account=user%40example.com&mailbox_guid=2550860f0c58d158c92a000044f0d230&query=savedbefore%2052w"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"64"}},"/get_login_url":{"get":{"description":"This function retrieves the login URL for the cPanel Store or a\ncPanel Market provider.","operationId":"get_login_url","parameters":[{"description":"The cPanel Store or cPanel Market provider's name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}},{"description":"The location to which the cPanel Store or cPanel Market provider\nredirects the user's browser after they log in.","in":"query","name":"url_after_login","required":true,"schema":{"example":"http://hostname.example.com/redirectionlocation.cgi?state","format":"url","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"The URL to which to redirect the browser after login.","example":"https://account.cpanel.net/oauth2/auth/login?client_id=d5eff4a09e29d5b20752674c0ab2c799c428eb23df4db2df10a5c9d96c37472c76013a41e9a0c714e852965ceaed2e8e05e2f738bc27ee562cfb683fbfc75a01&email=&redirect_uri=http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate&response_type=token","format":"url","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_login_url","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result`\nfield is `0`. This field may display a success message when\na function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel Store or cPanel Market login URL","tags":["Authentication","Login URL"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_login_url \\\n provider='cPStore' \\\n url_after_login='http://hostname.example.com/redirectionlocation.cgi?state'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_login_url?api.version=1&provider=cPStore&url_after_login=http%3a%2f%2fhostname.example.com%2fredirectionlocation.cgi%3fstate"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"62"}},"/expunge_mailbox_messages":{"get":{"description":"This function removes mail messages from a cPanel account that you select with a query.\n\n**Important:**\n\n When you disable the [Receive Mail role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"expunge_mailbox_messages","parameters":[{"description":"An email account that exists on the server.","in":"query","name":"account","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"A mailbox name on the account.\n\n**Note:**\n\n Because you cannot escape wildcard characters such as (`*`), we recommend that you use functions that use the `mailbox_guid` parameter instead. For example, the WHM API 1 `expunge_messages_for_mailbox_guid` function.","in":"query","name":"mailbox","required":true,"schema":{"example":"INBOX","type":"string"}},{"description":"A [Dovecot search query](http://wiki2.dovecot.org/Tools/Doveadm/SearchQuery) to select which messages you wish to remove from the mailbox.","in":"query","name":"query","required":true,"schema":{"example":"savedbefore 52w","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"expunge_mailbox_messages","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove email account messages by Dovecot query","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n expunge_mailbox_messages \\\n account='user@example.com' \\\n mailbox='INBOX' \\\n query='savedbefore 52w'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/expunge_mailbox_messages?api.version=1&account=user%40example.com&mailbox=INBOX&query=savedbefore%2052w"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/get_mailbox_status":{"get":{"description":"This function lists the status of a cPanel's mail account's mailboxes.\n\n**Important:**\n\n When you disable the [*Receive Mail* role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"get_mailbox_status","parameters":[{"description":"An email account or cPanel account's username.\n\n**Note:**\n\n`_mainaccount` is an alias representing the cPanel user's mailbox (for example, `_mainaccount@example.com represents the example mailbox.)","in":"query","name":"account","required":true,"schema":{"example":"user@example.com","oneOf":[{"format":"email","type":"string"},{"format":"username","type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"additionalProperties":{"description":"An object containing information about the mailbox's contents.\n\n**Note:**\n\nThe mailbox name is the return's name.","properties":{"guid":{"description":"The mailbox globally unique identifier (GUID).","example":"1234560f0c58d158c92a000044f0d230","type":"string"},"messages":{"description":"The total number of messages in the mailbox.","example":0,"minimum":0,"type":"integer"},"vsize":{"description":"The total virtual size of the mailbox's contents with `CRLF` line terminators.","example":0,"format":"bytes","minimum":0,"type":"integer"}},"type":"object"},"example":{"INBOX":{"guid":"111111234560f0c58d158c92a000044f","messages":42000,"vsize":42},"INBOX.Drafts":{"guid":"11111111234560f0c58d158c92a00000","messages":5,"vsize":522},"INBOX.Sent":{"guid":"1111111234560f0c58d158c92a000004","messages":1,"vsize":56},"INBOX.Trash":{"guid":"1111234560f0c58d158c92a000044f0d","messages":2001,"vsize":5643},"INBOX.angel_face@example_com":{"guid":"11234560f0c58d158c92a000044f0d23","messages":3,"vsize":1524},"INBOX.marla_singer@example_com":{"guid":"1234560f0c58d158c92a000044f0d230","messages":5,"vsize":100},"INBOX.narrator@example_com":{"guid":"11111234560f0c58d158c92a000044f0","messages":0,"vsize":0},"INBOX.robert_paulsen@example_com":{"guid":"111111111234560f0c58d158c92a0001","messages":2,"vsize":2222},"INBOX.tyler_durden@example_com":{"guid":"111234560f0c58d158c92a000044f0d2","messages":55,"vsize":12244}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_mailbox_status","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account mailboxes status by name","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_mailbox_status \\\n account='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_mailbox_status?api.version=1&account=user%40example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/setsiteip":{"get":{"description":"This function changes a site's or account's IP address.","operationId":"setsiteip","parameters":[{"description":"The site's or user's IPv4 address.","in":"query","name":"ip","required":true,"schema":{"example":"192.168.4.10","format":"ipv4","type":"string"}},{"description":"The user's username.\n\n**Note:**\n\nYou **must** use either the `user` parameter or `domain` parameter.","in":"query","name":"user","schema":{"example":"username","format":"username","type":"string"}},{"description":"The domain's name.\n\n**Note:**\n\nYou **must** use either the `user` parameter or `domain` parameter.","in":"query","name":"domain","schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"setsiteip","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update domain or cPanel account IP address","tags":["IP Addresses","IPv4 Address Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n setsiteip \\\n ip='192.168.4.10'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/setsiteip?api.version=1&ip=192.168.4.10"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/get_mailbox_status_list":{"get":{"description":"This function lists the status of a cPanel's mail account's mailboxes.\n\n**Important:**\n\n When you disable the [Receive Mail role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"get_mailbox_status_list","parameters":[{"description":"The email account's name.","example":"user@example.com","in":"query","name":"account","required":true,"schema":{"anyOf":[{"description":"A valid email account that exists on the server","example":"user@example.com","format":"email","type":"string"},{"description":"The cPanel user's account name.","example":"example","format":"username","type":"string"},{"description":"An alias that represents the cPanel user's mailbox","example":"_mainaccount@example.com","format":"email","type":"string"}],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"mailboxes":{"description":"An array that contains information about the mailbox's contents.","items":{"properties":{"guid":{"description":"The alpha-numeric 32-byte mailbox GUID.","example":"1234560f0c58d158c92a000044f0d230","type":"string"},"mailbox":{"description":"The mailbox name.","example":"INBOX.marla_singer@example_com","type":"string"},"messages":{"description":"The total number of messages in the mailbox.","example":0,"minimum":0,"type":"integer"},"vsize":{"description":"The total virtual size of the mailbox's contents, computed with CRLF line terminators.","example":0,"format":"bytes","minimum":0,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_mailbox_status_list","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account mailboxes status list","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_mailbox_status_list \\\n account='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_mailbox_status_list?api.version=1&account=user%40example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"64"}},"/disable_market_provider":{"get":{"description":"This function disables a cPanel Market provider.","operationId":"disable_market_provider","parameters":[{"description":"The cPanel Market provider's name.","in":"query","name":"name","required":true,"schema":{"example":"cPStore","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"disable_market_provider","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable Market provider","tags":["Market","Provider Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n disable_market_provider \\\n name='cPStore'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/disable_market_provider?api.version=1&name=cPStore"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/get_adjusted_market_providers_products":{"get":{"description":"This function lists all available cPanel Market products from enabled providers,\nwith the prices that the adjustments database modifies.","operationId":"get_adjusted_market_providers_products","parameters":[],"responses":{"200":{"content":{"application/json":{"examples":{"group_ssl_certificate":{"summary":"product_group=ssl_certificate","value":{"data":{"products":[{"base_name":"","billing_type":"one-time","description":"An extended-validated (EV) SSL certificate signed by cPanel.","display_name":"cPanel EV SSL Certificate","enabled":1,"icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","icon_mime_type":"image/svg+xml","license_term":0,"max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"cPanel EV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":209,"provider_display_name":"cPanel Store","provider_name":"cPStore","recommended":0,"requires_ip":0,"x_certificate_term":[1,"year"],"x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"is_optional":1,"label":"Department Name","name":"organizationalUnitName"},{"description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":1,"label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"},{"label":"Street Address","name":"streetAddress"},{"label":"City","name":"localityName"},{"label":"State or Province","name":"stateOrProvinceName"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","name":"countryName","type":"country_code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"label":"Representative’s Email Address","name":"rep_email_address","type":"email"},{"description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":1,"label":"Representative’s Telephone Number","name":"rep_telephone","type":"tel"},{"description":"Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options.","label":"Business Category","name":"business_category","options":[["b","Incorporated Business (“Private Organization”)"],["d","Non-incorporated Business (“Business Entity”)"],["c","Government Entity (“Government Entity”)"]],"type":"choose_one"},{"is_optional":1,"label":"City Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_locality_name"},{"is_optional":1,"label":"State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_state_or_province_name"},{"label":"Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_country_name","type":"country_code"},{"is_optional":1,"label":"Date of Incorporation","name":"date_of_incorporation","type":"date"},{"is_optional":1,"label":"Assumed Name (DBA (Doing Business As))","name":"assumed_name"}],"x_max_http_redirects":0,"x_payment_trigger":"checkout","x_price_per_domain":60,"x_price_per_domain_maximum":600,"x_price_per_domain_minimum":60,"x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"ev","x_warn_after":604800}]},"metadata":{"command":"get_adjusted_market_providers_products","reason":"OK","result":1,"version":1}}}},"schema":{"properties":{"data":{"properties":{"products":{"description":"An array of objects that contains information about the products in the cPanel Market.","items":{"additionalProperties":{"description":"Any product-specific additional properties. Each additional property value begins with the `x_` prefix.","x-additionalPropertiesName":"x_properties"},"properties":{"base_name":{"description":"The base name, if one exists.","type":"string"},"billing_type":{"description":"The billing type.","example":"one-time","type":"string"},"description":{"description":"The product's description.","example":"Get an SSL Certificate today.","type":"string"},"display_name":{"description":"The product's display name.","example":"Extended Validated cPanel SSL Certificate","type":"string"},"enabled":{"description":"Whether the product is enabled.\n\n* `0` - Disabled.\n* `1` - Enabled.","enum":[0,1],"example":1,"type":"integer"},"icon":{"description":"The icon to display in the product list.","example":"iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAKq2lDQ1BJQ0MgUHJvZmlsZQAASImV\nlgdQU+kWx7970xstAQEpoffeQUroofcmKiGhhBJiICDYEXEFVhQRacqCrjQFV6XIKiIWRFkUG/YF\nWRTUdbFgQ+Vd4BHee/N23rwzc3J/c+Z8/3vul++b+QNAvsfi81NgCQBSeRmCIA9nekRkFB33O8AC\nJUAC2kCFxU7nMwICfMDfxoe7AJp73jKY0/r7vv8akpy4dDYAUADCsZx0dirCp5DsZvMFGQCgkARq\nWRn8OS5HmCZABkT46BwnLHDPHMcu8O35npAgF4QnAMCTWSxBAgCk90idnslOQHTINISNeRwuD2FX\nhB3YiSwOwnkI66emps3xcYS1Y/9FJ+HfNGNFmixWgogXvmU+8K7cdH4KK/v/3I7/HakpwsV3qCJJ\nThR4BiFPGWTPGpLTvEXMi/XzX2QuZ75/nhOFnqGLzE53iVpkDsvVe5GFyaGMRWYJltZyM5ghiyxI\nCxLpx6W7BYv045g+ohlS/EQcz3VnLnJOYkj4Imdyw/wWOT052Hupx0VUFwiDRDPHC9xF35iavjQb\nm7U0Q0ZiiOfSbBGiGThxrm6iOi9U1M/PcBZp8lMCRP1xKR6ienpmsGhtBnLAFjmJ5RWwpBMg2h/A\nAMEgFEk6CAOewBSYI4lMlRG3bu5MA5c0fraAm5CYQWcgtyaOzuSxDfXppsYmFgDM3cGFv/jd9fm7\nBcnGLtWykPUrviNnkbBUi3gKwDGkJs9aqmluBkAaBUBbL1soyFyooed+MIAIxAENyCF3XA254wbI\nZJbADjgBN+AF/EEIiASrARskglQgAFlgA9gK8kEh2A32gUpQAw6BBnAMnAAd4Aw4Dy6Da+AGuAMe\nghEwDl6CKfABzEAQhIMoEBWSg5QhDUgPMoWsIQfIDfKBgqBIKAZKgHiQENoAbYMKoRKoEqqFGqFf\noNPQeagfGoLuQ6PQJPQW+gKjYDJMgxVhTdgItoYZsDccAq+CE+C1cA6cB++Cy+E6+CjcDp+Hr8F3\n4BH4JTyNAigSSgalgjJAWaNcUP6oKFQ8SoDahCpAlaHqUC2oLlQf6hZqBPUK9RmNRVPRdLQB2g7t\niQ5Fs9Fr0ZvQRehKdAO6HX0RfQs9ip5Cf8dQMAoYPYwthomJwCRgsjD5mDLMEUwb5hLmDmYc8wGL\nxcpgtbBWWE9sJDYJux5bhD2AbcX2YIewY9hpHA4nh9PD2eP8cSxcBi4fV4E7ijuHu4kbx33Ck/DK\neFO8Oz4Kz8Pn4svwTfhu/E38c/wMQYKgQbAl+BM4hGxCMeEwoYtwnTBOmCFKErWI9sQQYhJxK7Gc\n2EK8RHxEfEcikVRJNqRAEpe0hVROOk66QholfSZLkXXJLuRospC8i1xP7iHfJ7+jUCiaFCdKFCWD\nsovSSLlAeUL5JEYVMxRjinHENotVibWL3RR7LU4Q1xBniK8WzxEvEz8pfl38lQRBQlPCRYIlsUmi\nSuK0xLDEtCRV0kTSXzJVskiySbJfckIKJ6Up5SbFkcqTOiR1QWqMiqKqUV2obOo26mHqJeo4DUvT\nojFpSbRC2jHaIG1KWkraXDpMep10lfRZ6REZlIymDFMmRaZY5oTMXZkvyxSXMZbFLdu5rGXZzWUf\nZZfLOsnGyRbItsrekf0iR5dzk0uW2yPXIfdYHi2vKx8onyV/UP6S/KvltOV2y9nLC5afWP5AAVbQ\nVQhSWK9wSGFAYVpRSdFDka9YoXhB8ZWSjJKTUpJSqVK30qQyVdlBmatcqnxO+QVdms6gp9DL6Rfp\nUyoKKp4qQpValUGVGVUt1VDVXNVW1cdqRDVrtXi1UrVetSl1ZXVf9Q3qzeoPNAga1hqJGvs1+jQ+\nampphmvu0OzQnNCS1WJq5Wg1az3Spmg7aq/VrtO+rYPVsdZJ1jmgc0MX1rXQTdSt0r2uB+tZ6nH1\nDugN6WP0bfR5+nX6wwZkA4ZBpkGzwaihjKGPYa5hh+FrI3WjKKM9Rn1G340tjFOMDxs/NJEy8TLJ\nNekyeWuqa8o2rTK9bUYxczfbbNZp9sZczzzO/KD5PQuqha/FDotei2+WVpYCyxbLSSt1qxiraqth\na5p1gHWR9RUbjI2zzWabMzafbS1tM2xP2P5lZ2CXbNdkN7FCa0XcisMrxuxV7Vn2tfYjDnSHGIef\nHEYcVRxZjnWOT53UnDhOR5yeM3QYSYyjjNfOxs4C5zbnjy62LhtdelxRrh6uBa6DblJuoW6Vbk/c\nVd0T3JvdpzwsPNZ79HhiPL0993gOMxWZbGYjc8rLymuj10Vvsnewd6X3Ux9dH4FPly/s6+W71/eR\nn4Yfz6/DH/gz/ff6Pw7QClgb8GsgNjAgsCrwWZBJ0IagvmBq8JrgpuAPIc4hxSEPQ7VDhaG9YeJh\n0WGNYR/DXcNLwkcijCI2RlyLlI/kRnZG4aLCoo5ETa90W7lv5Xi0RXR+9N1VWqvWrepfLb86ZfXZ\nNeJrWGtOxmBiwmOaYr6y/Fl1rOlYZmx17BTbhb2f/ZLjxCnlTMbZx5XEPY+3jy+Jn0iwT9ibMJno\nmFiW+Irrwq3kvknyTKpJ+pjsn1yfPJsSntKaik+NST3Nk+Il8y6mKaWtSxvi6/Hz+SNrbdfuWzsl\n8BYcSYfSV6V3ZtAQszMg1BZuF45mOmRWZX7KCss6uU5yHW/dQLZu9s7s5znuOT+vR69nr+/doLJh\n64bRjYyNtZugTbGbejerbc7bPL7FY0vDVuLW5K2/5RrnluS+3xa+rStPMW9L3th2j+3N+WL5gvzh\nHXY7an5A/8D9YXCn2c6Knd8LOAVXC40Lywq/FrGLrv5o8mP5j7O74ncNFlsWH9yN3c3bfXeP456G\nEsmSnJKxvb5720vppQWl7/et2ddfZl5Ws5+4X7h/pNynvLNCvWJ3xdfKxMo7Vc5VrdUK1TurPx7g\nHLh50OlgS41iTWHNl5+4P92r9ahtr9OsKzuEPZR56NnhsMN9P1v/3HhE/kjhkW/1vPqRhqCGi41W\njY1NCk3FzXCzsHnyaPTRG8dcj3W2GLTUtsq0Fh4Hx4XHX/wS88vdE94nek9an2w5pXGquo3aVtAO\ntWe3T3Ukdox0RnYOnfY63dtl19X2q+Gv9WdUzlSdlT5b3E3szuuePZdzbrqH3/PqfML5sd41vQ8v\nRFy4fTHw4uAl70tXLrtfvtDH6Dt3xf7KmX7b/tNXra92XLO81j5gMdD2m8VvbYOWg+3Xra533rC5\n0TW0Yqj7puPN87dcb12+zbx97Y7fnaG7oXfvDUcPj9zj3Ju4n3L/zYPMBzMPtzzCPCp4LPG47InC\nk7rfdX5vHbEcOTvqOjrwNPjpwzH22Ms/0v/4Op73jPKs7Lny88YJ04kzk+6TN16sfDH+kv9y5lX+\nn5J/Vr/Wfn3qL6e/BqYipsbfCN7Mvi16J/eu/r35+97pgOknH1I/zHws+CT3qeGz9ee+L+Ffns9k\nfcV9Lf+m863ru/f3R7Ops7N8loA1bwUQZwDg+HgA3tYDQIkEgHoDAKLYgkeeD2jB188T+Dte8NHz\nYQnA4R4A5qwa0wmACoS1EKZuAWDOIiHWCDYzE+U/Iz3ezHRBiyyPWJOe2dm3swDgYgD4Njg7O1M+\nO/utDBkW8dfn/Ba8+byP4QKg/g7AOjX9jXVbwH/EPwCGGQVDbR7I2wAAAAlwSFlzAAALEwAACxMB\nAJqcGAAAAgRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRv\nYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6\ncmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAg\nPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6ZXhpZj0iaHR0\ncDovL25zLmFkb2JlLmNvbS9leGlmLzEuMC8iCiAgICAgICAgICAgIHhtbG5zOnRpZmY9Imh0dHA6\nLy9ucy5hZG9iZS5jb20vdGlmZi8xLjAvIj4KICAgICAgICAgPGV4aWY6UGl4ZWxZRGltZW5zaW9u\nPjM5MzwvZXhpZjpQaXhlbFlEaW1lbnNpb24+CiAgICAgICAgIDxleGlmOlBpeGVsWERpbWVuc2lv\nbj41MTU8L2V4aWY6UGl4ZWxYRGltZW5zaW9uPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4x\nPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRG\nPgo8L3g6eG1wbWV0YT4KxfVkQAAACgpJREFUWAmNV1lvG9cZPTMcLsN9EUmJlCzJ+9oEaZAu6WIU\nCVD0pb+lr31x3/oL8hKgaOOiQVugRV10SZG2dlGntqPElmzZliWLEimJkkhxEfchh5ye71LMQ2Cg\nHXI4w5k793zL+c53R3McZ4T/Y+M4NUrTNHUcjYYYDm11brgMaLpLnTtwoPHzv7YJrPHliV/1oIyZ\nAA/6XTx//CmKu3nYgyH6/QEE78rrb+HC5dehiZ3jn1dN9aVrGnSZeDK5AE32ycgJeHHnJSqlAtwe\nE51mHceVffQ6NTTqFRQL27j1y/ewuvIZwTWMRuNoTeZ41VECKsHUD4q76HbbaszEmIlBo9FIGbeb\n38CtX/wUrUZFjZs5dRr+oB8ejwfBkIlIPIFgfA4f/eG3KB3uQdd15cirgCfXxpnU4Dozl7mR29zA\nPg1pt5oYjmy4XC643W410WBg4Y8fvodWs4OF8+cxlV5QwAd7GzSoBZfhQnwqBq/P5PMWnj1+gFgy\nicRU+gsjJg5NwCdHuW643F40jluoVmp4uvoUhttAOBJBPJHA/OIi2rVDHOS34I/GGe4an+0TzIDH\n68dxowCfPwgzOMSFqxe4X8L6sw38+oMP8KMf/wTBQFBhSRplm6RT/ZH//Bg2may5NLgNLzyayUtA\nq9VBu9PFxtoKuod59G0X6kUJv0PiDWhkALMLZ7D29KlKkdc0MbB6+Oc//o3l53v4zpuXUC5uwz1/\nbhxJTVeYr4qEIXdUroXK2gjMOgxDg1ezkMu9RK9tMRKz+Nb3vst7OnIvPsfC6TOYnklhevYUKpUq\nU+bmuA5e5Kr45EUZ0zE/0o/v4b33f4ZAOIZsJouZ6TTS6TRi0RiCwSCjE4DP9MEYDGzmdJzvISVB\nrCwVC9h8toqdwwbOz6cxf3oej5ZX0Kx38e73r2Nl6QEuXbuKuYV5HB830LcsVkUVn9+7j93NEqw3\nstg/alEbdOXM/sEunj9/hkq1gS7H+v0mkskEMplpGH/501+Ryc4gNZ1CNB5HIBjA6vOXOCqUkT01\ni7m5Gdy9ex+f5i28/do5FHLb8IfCrJwen5vFTn4HAf5vVOpYnI4AzTJqlQpWn72ESQ4kOGf2VAap\nqZTihEGC2/aQz3dRrzfg8jj6jZer63jy6Cm2clsolcowmYJTmSnYFJlINIBHT9ZhUW9WN/IIDDs4\ne+40UjMM59QUmo0mfD4fRiRaMkrSuU3uHhgs0Xari4P9A2yu57C2to7t7QKqtSqEd5KGbDYDw8s8\nmAG/IsnAtrWVpcfOO+98jWXEXMWGWq8/cEL+APJPt5XAtFuzrJpjlp+blRBFeiaDWrVMHYjCzYq4\ndu0iljfyGlPruGmEyzDg9XhVuXY7PWxsbDEdG5TxIdOja/poOCKzbQgXmH4nkghj/7CCkdvFHM84\nNZaox+dHLGLira9eQIq5K1fr6Pb6NJq5TKdU5TSbTbhIrMpxE8f1uiNixLqDQzGzbVvt/MOqcCEU\nDmAqEUc0GnMMqUUpr5HDKmBbklotHpRx9z99xONhjJgvP6O0eO4s5skHw+OCTo8GtgVn2ACVS+V6\nUKqhzxK9/MZrqLR76PVtiszYiJEzlAJTBMdQg+3YPJDwOnuBAPKrrBULpSSFKM1Gh9qew1GFHtEr\nh5M0qA9dhk60/rjWQP1oh2NHiJLVsWgUnY6lyOVnSvd29tCllgw5dlz/DC+Bxl1U5hjvrlQ8foO+\nQwLA+9KZVJuVUtE9hkZeiEKgUathmhGYSsaVuHg8BlLRCCKJGDQaFaAU23Sk37dQKOzig5sfolNr\noUxSt6kRkgZp08IJg7vIvUaBUkI0JICgy5f4TAfoTRce0+cM+n006bmb0bSsvpLqKIGlEbXqdSQS\nEQST5+ANVfEV3cB6bgtrlPQgQrB6HVSKh1hfXqaEAeFYCkk6kWTJx6YS5EBUDKDbdF/CI+eOhIJW\nWATuk5hyTdJyjVq/ub6FK1cvYo51PTs7gw7Fp16tIBHJwGHTSqcSFJsqlj7+F+KZOWbUgS8SIFVZ\nnlwjCJ92Xmxi7fEjoRvi3giYgtgN3lVA45XMybmUBI3SGapyqY4LFxYRCQVUiNOsFL/XgOn1KRJG\nkmGs3L4NG26kZ7MUFzd+/+ePkGbFdFttusCokqzs/jB8HopdmDoQhsY0koQTcN7nKWOgTuQoBsjd\nTqevJHeBkpyjGH3y8R0Ut/NIZrPokPHN4gGqrR5uvv9zHLCCrr97nU+BXTMArxkg+JBz0QhZxjEK\n0tAGFLkheaEiMAGVhwRepUOWVSot7A0Mc4rCdO3qeaSnkySfH8lMho0miifLT3Dnb7dZuhVs7JSw\nVThk81pAkVXw6dIjhMMhpQVDgo+XamMMqTjBMtSv8pM3CKowxXtVtzo6vR5CpheF7T2l4abfhxBJ\nGI5PsVsWcO+zxziotGhMCKn5OeS2d2Dee4jM3Cmm5A4FzlLSSyw1pxIEpkKcFh+FnGqTC/JRFvAg\nobcZujZzGGRJFkoHVMgjyrwPJapjqXKM7fwu1pgSf8BUHbXB5mJ3W9jObamKCZF+smISLZCoisfi\noEJS/7kgcUSiFA8IOhISqGGKpV1670glcHkm205+D4uLc2rxsbu7rxqRTcUrU7qbzQaOKNE7+SLe\n+uabFKEeTK4XRzZXEeLNiQECr7KrrjECCk9NLz8CLhvlkmSRRYZouiZPcOuzNK12F/IG0OL60SGz\nq/Um7t5/iFxhDy222KNGGVeunOGiZQalZlUq+gRc/JZKkBAw/yxtkWhyQCbnKMk/zyaWihBpDJ0u\n5o/xWUKiYroy5JjipDkuZGen8WB5HSOOYwPE21//Bi5fPoNc3iuzcbnHfIuyjcOg4E6mU/Oy88vG\nS2Icj5INa0ARojeqmchVGilkabLkNOqCpEVC17O6XNWk8cMffFtx5ezZWVykXkQpPpFIiE/wjUlW\n11xzDhkt6QnKzS8sUCQUwSHISZglPF0VZnlroXCI5SRjOhbHk2ebBO1DI7Es8kOiIxGZyyRx9dJp\nzGeTFBifCm+AxIVBIwjqD/uVECnckx8xRD66m8vwkdTcyQ0BGHL54+bEkmu+OinS+Px+VI4OsXtQ\nYo/g5Lwr7BYDfaJuAR9Ljrxh5ERocly6wa6pdaE/HOH0KsQKRqBU5Hmim14vJ1LtiI46ir0Crlqo\njDoZqR4y/Li/tIIBx8diIZYe1wbMsURClRkHieqVyxXcuXOfD5toNNtclh1xHOlG4k1IILQQr3Uv\nu5pcFJweV6w0X02osBX4eKCLQCm24pWVJ0zFBvXeBS/zyzdBjNcdLDcSRafxD6iAS9xnZuIq9/LO\nMM7+JPCCLhFhmoVo8no9YNlZJ8RT6jQB51idr94Wjev2LIRCEfzmd3/H9s6hYrjX64bJpiIeyLRL\nD5/j5q9ucd0wTTKPu6mLTkqEtBNHxRj15f//Ah9jPXoBZ9CgAAAAAElFTkSuQmCC","format":"base64 image","type":"string"},"icon_mime_type":{"description":"The icon's image format.","example":"image/svg+xml","type":"string"},"license_term":{"description":"The license term.","example":0,"type":"integer"},"max_users":{"description":"The maximum number of users.","minimum":1,"nullable":true,"type":"integer"},"maximum_server_price":{"description":"\nThe product's maximum price.\n\n* null - The produce does **not** possess a maximum price.","example":888.88,"format":"currency","minimum":0,"nullable":true,"type":"number"},"minimum_server_price":{"description":"\nThe product's minimum price.\n\n* null - The product does **not** possess a minimum price.","example":3,"format":"currency","minimum":0,"nullable":true,"type":"number"},"price":{"description":"The product's price.\n\n* null - The product does **not** possess a static price.","example":6,"format":"currency","minimum":0,"nullable":true,"type":"number"},"price_unit":{"description":"The currency code of the product's price, in [ISO-4217 format](https://en.wikipedia.org/wiki/ISO_4217) format.","example":"USD","type":"string"},"product":{"description":"The product's display name.","example":"cPanel EV Certificate","type":"string"},"product_category":{"description":"The product's category.","example":"N/A","nullable":true,"type":"string"},"product_group":{"description":"The product's group.","example":"ssl_certificate","type":"string"},"product_id":{"description":"The product ID.","example":209,"minimum":1,"type":"integer"},"provider_display_name":{"description":"The cPanel Market provider's display name.","example":"cPanel Store","type":"string"},"provider_name":{"description":"The cPanel Market provider's name.","example":"cPStore","type":"string"},"recommended":{"description":"Whether we recommend the product.\n* `1` - We recommend the product.\n* `0` - We do **not** recommend the product.","enum":[0,1],"example":1,"type":"integer"},"requires_ip":{"description":"Whether the product requires an IP.\n* `1` - Requires an IP address.\n* `0` - Does **not** require an IP address.","enum":[0,1],"example":1,"type":"integer"}}},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_adjusted_market_providers_products","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Market providers' products adjusted prices","tags":["Market","Product Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_adjusted_market_providers_products\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_adjusted_market_providers_products?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/enable_market_provider":{"get":{"description":"This function enables a cPanel Market provider.","operationId":"enable_market_provider","parameters":[{"description":"The cPanel Market provider's name.","in":"query","name":"name","required":true,"schema":{"example":"cPStore","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"enable_market_provider","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable Market provider","tags":["Market","Provider Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n enable_market_provider \\\n name='cPStore'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/enable_market_provider?api.version=1&name=cPStore"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/get_market_providers_commission_config":{"get":{"description":"This function returns the commission configuration of all available cPanel Market providers.","operationId":"get_market_providers_commission_config","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects that contains commission ID information about a cPanel Market provider.","items":{"properties":{"local_commission_id":{"description":"The locally-cached commission ID that the server owner uses for the cPanel Market provider.","example":"user@example.com","format":"email","type":"string"},"provider_display_name":{"description":"The cPanel Market provider's display name.","example":"cPanel Store","type":"string"},"provider_name":{"description":"The cPanel Market provider's name.","example":"cPStore","type":"string"},"remote_commission_id":{"description":"The commission ID that the server owner uses for the cPanel Market provider.","example":"user@example.com","format":"email","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_market_providers_commission_config","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Market providers' commission configuration","tags":["Market","Provider Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_market_providers_commission_config\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_market_providers_commission_config?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/get_market_providers_list":{"get":{"description":"This function lists the available cPanel Market providers.","operationId":"get_market_providers_list","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects with information about each cPanel Market provider.","items":{"properties":{"display_name":{"description":"The cPanel Market provider's display name.","example":"cPanel Store","type":"string"},"enabled":{"description":"Whether the cPanel Market provider is enabled.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[0,1],"example":1,"type":"integer"},"even_commission_divisor":{"description":"The price of the Market provider's products must be a multiple of this value.\n\n**Note:**\n\n This function returns the even_commission_divisor value only if the `supports_commission` value is `1`.","example":6,"type":"integer"},"name":{"description":"The cPanel Market provider's name.","example":"cPStore","type":"string"},"supports_commission":{"description":"Whether the cPanel Market provider supports sales commissions.\n* `1` - The provider supports commissions.\n* `0` - The provider does **not** support commissions.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_market_providers_list","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Market providers","tags":["Market","Provider Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_market_providers_list\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_market_providers_list?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/get_market_providers_product_metadata":{"get":{"description":"This function lists all available cPanel Market providers' products and the attributes of\neach product that can be managed by an administrator.\n\nThe return list includes different `attribute` data depending the `product_group` for each product.\n\n<table>\n <tr>\n <th>Product Group</th>\n <th>Attributes Returned</th>\n <th>Description</th>\n </tr>\n <tr>\n <td>ssl_certificate</td>\n <td>SSLMarketProviderMetaData</td>\n <td>Contains additional attributes only applicable to SSL Certificates</td>\n </tr>\n <tr>\n <td>*</td>\n <td>MarketProviderMetaData</td>\n <td>Any products not in a <code>product_group</code> listed above will include only these attributes.</td>\n </tr>\n</table>\n\n**Note:**\n\nThe function does **not** return the `product_group` name.\n\nTo get the `product_group` name for a `product_id`, run WHM API 1's [`get_market_providers_products`](https://go.cpanel.net/Market-get-market-providers-products) function.","operationId":"get_market_providers_product_metadata","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"product_metadata":{"items":{"properties":{"attributes":{"oneOf":[{"$ref":"#/components/schemas/MarketProviderMetaData"},{"$ref":"#/components/schemas/SSLMarketProviderMetaData"}]},"product_id":{"description":"The product's ID.","example":"123","type":"string"},"provider_display_name":{"description":"The cPanel Market provider's display name.","example":"cPanel Store","type":"string"},"provider_name":{"description":"The cPanel Market provider's name.","example":"cPStore","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_market_providers_product_metadata","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Market providers' products metadata","tags":["Market","Product Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_market_providers_product_metadata\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_market_providers_product_metadata?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/set_market_provider_commission_id":{"get":{"description":"This function sets the contact ID to which a cPanel Market provider will send commission.","operationId":"set_market_provider_commission_id","parameters":[{"description":"The cPanel Market provider's name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}},{"description":"The cPanel Store ID to which to send cPanel Market commissions.","in":"query","name":"commission_id","required":true,"schema":{"example":"user@example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_market_provider_commission_id","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update Market provider commission contact ID","tags":["Market","Provider Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_market_provider_commission_id \\\n provider='cPStore' \\\n commission_id='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_market_provider_commission_id?api.version=1&provider=cPStore&commission_id=user%40example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/get_market_providers_products":{"get":{"description":"This function lists products available in the server's cPanel Market.","operationId":"Market-get_market_providers_products","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"products":{"description":"A list of the products in the cPanel Market.\n\n**Note:**\n\nAdditional returns that correspond to each product may appear.","example":[{"base_name":"","billing_type":"one-time","description":"An extended-validated (EV) SSL certificate signed by COMODO.","display_name":"Comodo EV SSL Certificate","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","icon_mime_type":"image/svg+xml","license_term":"0","max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"Comodo EV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":"155","provider_display_name":"cPanel Store","provider_name":"cPStore","requires_ip":"0","x_certificate_term":["1","year"],"x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"is_optional":1,"label":"Department Name","name":"organizationalUnitName"},{"description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":1,"label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"},{"label":"Street Address","name":"streetAddress"},{"label":"City","name":"localityName"},{"label":"State or Province","name":"stateOrProvinceName"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","name":"countryName","type":"country_code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"label":"Representative’s Email Address","name":"rep_email_address","type":"email"},{"description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":1,"label":"Representative’s Telephone Number","name":"rep_telephone","type":"tel"},{"description":"Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options.","label":"Business Category","name":"business_category","options":[["b","Incorporated Business (“Private Organization”)"],["d","Non-incorporated Business (“Business Entity”)"],["c","Government Entity (“Government Entity”)"]],"type":"choose_one"},{"is_optional":1,"label":"City Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_locality_name"},{"is_optional":1,"label":"State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_state_or_province_name"},{"label":"Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_country_name","type":"country_code"},{"is_optional":1,"label":"Date of Incorporation","name":"date_of_incorporation","type":"date"},{"is_optional":1,"label":"Assumed Name (DBA (Doing Business As))","name":"assumed_name"}],"x_max_http_redirects":0,"x_payment_trigger":"checkout","x_price_per_domain":108,"x_price_per_domain_maximum":1080,"x_price_per_domain_minimum":108,"x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"ev","x_warn_after":604800},{"base_name":"","billing_type":"one-time","description":"A 2-year extended-validated (EV) SSL certificate signed by Comodo.","display_name":"2-Year Comodo EV SSL Certificate","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","icon_mime_type":"image/svg+xml","license_term":"0","max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"Comodo EV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":"261","provider_display_name":"cPanel Store","provider_name":"cPStore","requires_ip":"0","x_certificate_term":["2","year"],"x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"is_optional":1,"label":"Department Name","name":"organizationalUnitName"},{"description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":1,"label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"},{"label":"Street Address","name":"streetAddress"},{"label":"City","name":"localityName"},{"label":"State or Province","name":"stateOrProvinceName"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","name":"countryName","type":"country_code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"label":"Representative’s Email Address","name":"rep_email_address","type":"email"},{"description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":1,"label":"Representative’s Telephone Number","name":"rep_telephone","type":"tel"},{"description":"Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options.","label":"Business Category","name":"business_category","options":[["b","Incorporated Business (“Private Organization”)"],["d","Non-incorporated Business (“Business Entity”)"],["c","Government Entity (“Government Entity”)"]],"type":"choose_one"},{"is_optional":1,"label":"City Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_locality_name"},{"is_optional":1,"label":"State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_state_or_province_name"},{"label":"Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_country_name","type":"country_code"},{"is_optional":1,"label":"Date of Incorporation","name":"date_of_incorporation","type":"date"},{"is_optional":1,"label":"Assumed Name (DBA (Doing Business As))","name":"assumed_name"}],"x_max_http_redirects":0,"x_payment_trigger":"checkout","x_price_per_domain":216,"x_price_per_domain_maximum":2160,"x_price_per_domain_minimum":216,"x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"ev","x_warn_after":604800},{"base_name":"","billing_type":"one-time","description":"An organization-validated (OV) SSL certificate signed by COMODO.","display_name":"Comodo OV SSL Certificate","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","icon_mime_type":"image/svg+xml","license_term":"0","max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"Comodo OV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":"217","provider_display_name":"cPanel Store","provider_name":"cPStore","requires_ip":"0","x_certificate_term":["1","year"],"x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"is_optional":1,"label":"Department Name","name":"organizationalUnitName"},{"description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":1,"label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"},{"label":"Street Address","name":"streetAddress"},{"label":"City","name":"localityName"},{"label":"State or Province","name":"stateOrProvinceName"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","name":"countryName","type":"country_code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"label":"Representative’s Email Address","name":"rep_email_address","type":"email"},{"description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":1,"label":"Representative’s Telephone Number","name":"rep_telephone","type":"tel"}],"x_max_http_redirects":0,"x_payment_trigger":"checkout","x_price_per_domain":36,"x_price_per_domain_maximum":360,"x_price_per_domain_minimum":36,"x_price_per_wildcard_domain":"150.00","x_price_per_wildcard_domain_maximum":"1500.00","x_price_per_wildcard_domain_minimum":"150.00","x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"ov","x_warn_after":604800,"x_wildcard_parent_domain_free":1},{"base_name":"","billing_type":"one-time","description":"A 2-year organization-validated (OV) SSL certificate signed by Comodo.","display_name":"2-Year Comodo OV SSL Certificate","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","icon_mime_type":"image/svg+xml","license_term":"0","max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"Comodo OV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":"253","provider_display_name":"cPanel Store","provider_name":"cPStore","requires_ip":"0","x_certificate_term":["2","year"],"x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"is_optional":1,"label":"Department Name","name":"organizationalUnitName"},{"description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":1,"label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"},{"label":"Street Address","name":"streetAddress"},{"label":"City","name":"localityName"},{"label":"State or Province","name":"stateOrProvinceName"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","name":"countryName","type":"country_code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"label":"Representative’s Email Address","name":"rep_email_address","type":"email"},{"description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":1,"label":"Representative’s Telephone Number","name":"rep_telephone","type":"tel"}],"x_max_http_redirects":0,"x_payment_trigger":"checkout","x_price_per_domain":72,"x_price_per_domain_maximum":720,"x_price_per_domain_minimum":72,"x_price_per_wildcard_domain":"300.00","x_price_per_wildcard_domain_maximum":"3000.00","x_price_per_wildcard_domain_minimum":"300.00","x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"ov","x_warn_after":604800,"x_wildcard_parent_domain_free":1},{"base_name":"","billing_type":"one-time","description":"A domain-validated (DV) SSL certificate signed by cPanel.","display_name":"cPanel DV SSL Certificate","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","icon_mime_type":"image/svg+xml","license_term":"0","max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"cPanel DV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":"159","provider_display_name":"cPanel Store","provider_name":"cPStore","requires_ip":"0","x_certificate_term":["1","year"],"x_identity_verification":null,"x_max_http_redirects":0,"x_payment_trigger":"issuance","x_price_per_domain":9,"x_price_per_domain_maximum":30,"x_price_per_domain_minimum":3,"x_price_per_wildcard_domain":"75.00","x_price_per_wildcard_domain_maximum":"750.00","x_price_per_wildcard_domain_minimum":"75.00","x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"dv","x_warn_after":604800,"x_wildcard_parent_domain_free":1},{"base_name":"","billing_type":"one-time","description":"A 2-year domain-validated (DV) SSL certificate signed by cPanel.","display_name":"2-Year cPanel DV SSL Certificate","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","icon_mime_type":"image/svg+xml","license_term":"0","max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"cPanel DV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":"225","provider_display_name":"cPanel Store","provider_name":"cPStore","requires_ip":"0","x_certificate_term":["2","year"],"x_identity_verification":null,"x_max_http_redirects":0,"x_payment_trigger":"issuance","x_price_per_domain":18,"x_price_per_domain_maximum":60,"x_price_per_domain_minimum":6,"x_price_per_wildcard_domain":"150.00","x_price_per_wildcard_domain_maximum":"1500.00","x_price_per_wildcard_domain_minimum":"150.00","x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"dv","x_warn_after":604800,"x_wildcard_parent_domain_free":1},{"base_name":"","billing_type":"one-time","description":"An organization-validated (OV) SSL certificate signed by cPanel.","display_name":"cPanel OV SSL Certificate","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","icon_mime_type":"image/svg+xml","license_term":"0","max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"cPanel OV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":"213","provider_display_name":"cPanel Store","provider_name":"cPStore","requires_ip":"0","x_certificate_term":["1","year"],"x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"is_optional":1,"label":"Department Name","name":"organizationalUnitName"},{"description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":1,"label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"},{"label":"Street Address","name":"streetAddress"},{"label":"City","name":"localityName"},{"label":"State or Province","name":"stateOrProvinceName"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","name":"countryName","type":"country_code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"label":"Representative’s Email Address","name":"rep_email_address","type":"email"},{"description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":1,"label":"Representative’s Telephone Number","name":"rep_telephone","type":"tel"}],"x_max_http_redirects":0,"x_payment_trigger":"checkout","x_price_per_domain":30,"x_price_per_domain_maximum":300,"x_price_per_domain_minimum":30,"x_price_per_wildcard_domain":"99.00","x_price_per_wildcard_domain_maximum":"990.00","x_price_per_wildcard_domain_minimum":"99.00","x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"ov","x_warn_after":604800,"x_wildcard_parent_domain_free":1},{"base_name":"","billing_type":"one-time","description":"A 2-year organization-validated (OV) SSL certificate signed by cPanel.","display_name":"2-Year cPanel OV SSL Certificate","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","icon_mime_type":"image/svg+xml","license_term":"0","max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"cPanel OV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":"233","provider_display_name":"cPanel Store","provider_name":"cPStore","requires_ip":"0","x_certificate_term":["2","year"],"x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"is_optional":1,"label":"Department Name","name":"organizationalUnitName"},{"description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":1,"label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"},{"label":"Street Address","name":"streetAddress"},{"label":"City","name":"localityName"},{"label":"State or Province","name":"stateOrProvinceName"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","name":"countryName","type":"country_code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"label":"Representative’s Email Address","name":"rep_email_address","type":"email"},{"description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":1,"label":"Representative’s Telephone Number","name":"rep_telephone","type":"tel"}],"x_max_http_redirects":0,"x_payment_trigger":"checkout","x_price_per_domain":60,"x_price_per_domain_maximum":600,"x_price_per_domain_minimum":60,"x_price_per_wildcard_domain":"198.00","x_price_per_wildcard_domain_maximum":"1980.00","x_price_per_wildcard_domain_minimum":"198.00","x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"ov","x_warn_after":604800,"x_wildcard_parent_domain_free":1},{"base_name":"","billing_type":"one-time","description":"A domain-validated (DV) SSL certificate signed by COMODO.","display_name":"Comodo DV SSL Certificate","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","icon_mime_type":"image/svg+xml","license_term":"0","max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"Comodo DV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":"151","provider_display_name":"cPanel Store","provider_name":"cPStore","requires_ip":"0","x_certificate_term":["1","year"],"x_identity_verification":null,"x_max_http_redirects":0,"x_payment_trigger":"issuance","x_price_per_domain":12,"x_price_per_domain_maximum":120,"x_price_per_domain_minimum":12,"x_price_per_wildcard_domain":"99.00","x_price_per_wildcard_domain_maximum":"990.00","x_price_per_wildcard_domain_minimum":"99.00","x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"dv","x_warn_after":604800,"x_wildcard_parent_domain_free":1},{"base_name":"","billing_type":"one-time","description":"A 2-year domain-validated (DV) SSL certificate signed by Comodo.","display_name":"2-Year Comodo DV SSL Certificate","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","icon_mime_type":"image/svg+xml","license_term":"0","max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"Comodo DV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":"245","provider_display_name":"cPanel Store","provider_name":"cPStore","requires_ip":"0","x_certificate_term":["2","year"],"x_identity_verification":null,"x_max_http_redirects":0,"x_payment_trigger":"issuance","x_price_per_domain":24,"x_price_per_domain_maximum":240,"x_price_per_domain_minimum":24,"x_price_per_wildcard_domain":"198.00","x_price_per_wildcard_domain_maximum":"1980.00","x_price_per_wildcard_domain_minimum":"198.00","x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"dv","x_warn_after":604800,"x_wildcard_parent_domain_free":1},{"base_name":"","billing_type":"one-time","description":"An extended-validated (EV) SSL certificate signed by cPanel.","display_name":"cPanel EV SSL Certificate","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","icon_mime_type":"image/svg+xml","license_term":"0","max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"cPanel EV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":"209","provider_display_name":"cPanel Store","provider_name":"cPStore","requires_ip":"0","x_certificate_term":["1","year"],"x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"is_optional":1,"label":"Department Name","name":"organizationalUnitName"},{"description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":1,"label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"},{"label":"Street Address","name":"streetAddress"},{"label":"City","name":"localityName"},{"label":"State or Province","name":"stateOrProvinceName"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","name":"countryName","type":"country_code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"label":"Representative’s Email Address","name":"rep_email_address","type":"email"},{"description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":1,"label":"Representative’s Telephone Number","name":"rep_telephone","type":"tel"},{"description":"Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options.","label":"Business Category","name":"business_category","options":[["b","Incorporated Business (“Private Organization”)"],["d","Non-incorporated Business (“Business Entity”)"],["c","Government Entity (“Government Entity”)"]],"type":"choose_one"},{"is_optional":1,"label":"City Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_locality_name"},{"is_optional":1,"label":"State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_state_or_province_name"},{"label":"Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_country_name","type":"country_code"},{"is_optional":1,"label":"Date of Incorporation","name":"date_of_incorporation","type":"date"},{"is_optional":1,"label":"Assumed Name (DBA (Doing Business As))","name":"assumed_name"}],"x_max_http_redirects":0,"x_payment_trigger":"checkout","x_price_per_domain":60,"x_price_per_domain_maximum":600,"x_price_per_domain_minimum":60,"x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"ev","x_warn_after":604800},{"base_name":"","billing_type":"one-time","description":"A 2-year extended-validated (EV) SSL certificate signed by cPanel.","display_name":"2-Year cPanel EV SSL Certificate","icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","icon_mime_type":"image/svg+xml","license_term":"0","max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"cPanel EV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":"241","provider_display_name":"cPanel Store","provider_name":"cPStore","requires_ip":"0","x_certificate_term":["2","year"],"x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"is_optional":1,"label":"Department Name","name":"organizationalUnitName"},{"description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":1,"label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"},{"label":"Street Address","name":"streetAddress"},{"label":"City","name":"localityName"},{"label":"State or Province","name":"stateOrProvinceName"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","name":"countryName","type":"country_code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"label":"Representative’s Email Address","name":"rep_email_address","type":"email"},{"description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":1,"label":"Representative’s Telephone Number","name":"rep_telephone","type":"tel"},{"description":"Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options.","label":"Business Category","name":"business_category","options":[["b","Incorporated Business (“Private Organization”)"],["d","Non-incorporated Business (“Business Entity”)"],["c","Government Entity (“Government Entity”)"]],"type":"choose_one"},{"is_optional":1,"label":"City Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_locality_name"},{"is_optional":1,"label":"State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_state_or_province_name"},{"label":"Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_country_name","type":"country_code"},{"is_optional":1,"label":"Date of Incorporation","name":"date_of_incorporation","type":"date"},{"is_optional":1,"label":"Assumed Name (DBA (Doing Business As))","name":"assumed_name"}],"x_max_http_redirects":0,"x_payment_trigger":"checkout","x_price_per_domain":120,"x_price_per_domain_maximum":1200,"x_price_per_domain_minimum":120,"x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"ev","x_warn_after":604800}],"items":{"$ref":"#/components/schemas/MarketItemType"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_market_providers_products","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`.\nThis field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Market providers products","tags":["Market","Product Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_market_providers_products\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_market_providers_products?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/modsec_add_rule":{"get":{"description":"This function adds a new rule to a ModSecurity™ configuration staging file. For example, if you choose to add a rule for the example.conf file, the function stages the rule in the example.conf. STAGE file.\n\n**Important:**\n\n This function does not actually deploy the rule. To deploy the rule, use the WHM API 1 Functions - modsec_deploy_all_rule_changes function.\n\n**Important:**\n\n When you disable the Web Server role, the system disables this function.","operationId":"modsec_add_rule","parameters":[{"description":"The ModSecurity configuration file.","in":"query","name":"config","required":true,"schema":{"example":"modsec2.user.conf","type":"string"}},{"description":"The rule's text.","in":"query","name":"rule","required":true,"schema":{"example":"SecAction \"phase:1,id:168,nolog,pass,setvar:tx.REMOTE_ADDR=/%{REMOTE_ADDR}/\"","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"rule":{"description":"hash that contains information about the new ModSecurity rule. This hash includes the id , rule , disabled , meta_msg , and duplicate returns.","properties":{"config":{},"config_active":{},"disabled":{"description":"Whether the rule is disabled.\n- 1 Disabled.\n- 0 Enabled.","enum":[0,1],"example":0,"type":"integer"},"duplicate":{"description":"Whether the rule already exists in the ModSecurity configuration staging file.\n- 1 Exists.\n- 0 Does not exist.","enum":[0,1],"example":0,"type":"integer"},"id":{"description":"The ModSecurity rule's ID. A valid ModSecurity rule ID.","example":168,"type":"integer"},"meta_msg":{"description":"The ModSecurity rule's description. A valid string.","example":"Example rule message","type":"string"},"rule":{"description":"The ModSecurity rule's text. A valid ModSecurity rule.","example":"SecAction \\\"phase:1,id:168,nolog,pass,setvar:tx.REMOTE_ADDR=/%{REMOTE_ADDR}/\\\"","type":"string"},"staged":{},"vendor_active":{},"vendor_id":{}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_add_rule","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add staged ModSecurity rule","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_add_rule \\\n config='modsec2.user.conf' \\\n rule='SecAction \"phase:1,id:168,nolog,pass,setvar:tx.REMOTE_ADDR=/%{REMOTE_ADDR}/\"'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_add_rule?api.version=1&config=modsec2.user.conf&rule=SecAction%20%22phase%3a1%2cid%3a168%2cnolog%2cpass%2csetvar%3atx.REMOTE_ADDR%3d%2f%25%7bREMOTE_ADDR%7d%2f%22"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_add_vendor":{"get":{"description":"This function adds a new ModSecurity™ vendor rule set to the server.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system disables this function.","operationId":"modsec_add_vendor","parameters":[{"description":"The YAML metadata that describes the vendor and how to obtain its rules.","in":"query","name":"url","required":true,"schema":{"example":"https://example.com/update/meta_MyVendor.yaml","format":"url","type":"string"}},{"description":"Whether to enable the vendor.\n\n* `1` — Enabled.\n* `0` — Disabled.","in":"query","name":"enabled","required":false,"schema":{"default":1,"enum":[1,0],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"archive_url":{"description":"The URL to the vendor's rule set archive.\n\n**Note:**\n\nThe system will download a set of rules that is compatible with your version\nof ModSecurity.","example":"http://example.com/update/MyVendor.zip","format":"url","type":"string"},"cpanel_provided":{"description":"Whether WebPros International, LLC provided the vendor.\n\n* `1` — cPanel-provided.\n* `0` — **Not** cPanel-provided.","enum":[1,0],"example":0,"type":"integer"},"description":{"description":"The vendor's description.","example":"This is an example of a custom vendor set (updated)","type":"string"},"dist_md5":{"description":"The download's [MD5](https://en.wikipedia.org/wiki/MD5) checksum value.","example":"307cb5320441ebd712e5581d12100dc9","format":"md5","type":"string"},"dist_sha512":{"description":"The download's [sha512](https://en.wikipedia.org/wiki/SHA-2) hash.","example":"b55c09bb1835ed4209f0f3ea4a70d099665363f23d3819c0369be429438d675ba2c749dcefdb85cee682ee0bf485558e67d0b0965fe4799865529d943e8e14cb","format":"sha512","type":"string"},"enabled":{"description":"Whether the function enabled the vendor.\n\n* `1` — Enabled.\n* `0` — **Not** enabled.","enum":[1,0],"example":1,"type":"integer"},"inst_dist":{"description":"The rule set's unique identifier.","example":"MyVendor-2","type":"string"},"installed":{"description":"Whether the function installed the vendor.\n\n* `1` — Installed.\n* `0` — **Not** installed.","enum":[1,0],"example":1,"type":"integer"},"installed_from":{"description":"The vendor's metadata file URL.","example":"https://example.com/update/meta_MyVendor.yaml","format":"url","type":"string"},"name":{"description":"The vendor's name.","example":"My Vendor","type":"string"},"path":{"description":"The absolute path to the directory that contains the vendor's configuration files.","example":"/usr/local/apache/conf/modsec_vendor_configs/MyVendor","format":"path","type":"string"},"report_url":{"description":"The URL to which the system will send reports.","example":"https://waf.example.com/api/cpanel_feedback?source=1&rule_set=1.229","format":"url","type":"string"},"supported_versions":{"description":"A list of the ModSecurity versions that the vendor supports.","example":["2.7.5","2.7.7","2.8.0","2.9.0","2.9.1","2.9.2","2.9.3"],"items":{"type":"string"},"type":"array"},"vendor_id":{"description":"The vendor's unique short name.","example":"MyVendor","type":"string"},"vendor_url":{"description":"The vendor's website URL.","example":"http://www.example.com","format":"url","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_add_vendor","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add ModSecurity vendor rules","tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_add_vendor \\\n url='https://example.com/update/meta_MyVendor.yaml'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_add_vendor?api.version=1&url=https%3a%2f%2fexample.com%2fupdate%2fmeta_MyVendor.yaml"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_assemble_config_text":{"get":{"description":"This function adds text to a ModSecurity™ configuration file.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_assemble_config_text","parameters":[{"description":"The ModSecurity™ configuration filename and file path, relative to the `/etc/apache2/conf/` directory.","in":"query","name":"config","required":true,"schema":{"example":"modsec_vendor_configs/example.conf","type":"string"}},{"description":"The text to add to the configuration file.","in":"query","name":"text","required":false,"schema":{"default":"","example":"newtext","type":"string"}},{"description":"Whether to add the text as the initial upload to the configuration file.\n\n* `1` — Initial upload.\n* `0` — **Not** the initial upload.\n\n**Note:**\n\n* You **must** use this parameter if you wish to add the text as the initial\nchange to the configuration file.\n* You **must** use the `final` parameter with this parameter if you wish to\nonly make one change to the configuration file.","in":"query","name":"init","required":false,"schema":{"default":0,"enum":[1,0],"example":1,"type":"integer"}},{"description":"Whether to add the text as the final upload to the configuration file.\n\n* `1` — Final upload.\n* `0` — **Not** the final upload.\n\n**Note:**\n\n* You **must** use this parameter if you wish to add the text as the final\nchange to the configuration file.\n* You **must** use the `init` parameter with this parameter if you wish to\nonly make one change to the configuration file.","in":"query","name":"final","required":false,"schema":{"default":0,"enum":[1,0],"example":1,"type":"integer"}},{"description":"Whether to deploy the new text to the system.\n\n* `1` — Deploy.\n* `0` — Do **not** deploy.","in":"query","name":"deploy","required":false,"schema":{"default":0,"enum":[1,0],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_assemble_config_text","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add ModSecurity configuration file text","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_assemble_config_text \\\n config='modsec_vendor_configs/example.conf'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_assemble_config_text?api.version=1&config=modsec_vendor_configs%2fexample.conf"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/set_market_product_attribute":{"get":{"description":"This function sets an attribute for a cPanel Market provider's product.","operationId":"set_market_product_attribute","parameters":[{"description":"The cPanel Market provider's name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}},{"description":"The cPanel Market provider product's name.","in":"query","name":"product_id","required":true,"schema":{"example":"12345","type":"string"}},{"description":"The attribute of the cPanel Market provider's product.\n\n**Note**\n\nAttributes vary between cPanel Market providers and products.","in":"query","name":"attribute","required":true,"schema":{"example":"price","type":"string"}},{"description":"The value to set for the attribute.","in":"query","name":"value","required":true,"schema":{"example":"6.00","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_market_product_attribute","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update Market provider product","tags":["Market","Product Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_market_product_attribute \\\n provider='cPStore' \\\n product_id='12345' \\\n attribute='price' \\\n value='6.00'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_market_product_attribute?api.version=1&provider=cPStore&product_id=12345&attribute=price&value=6.00"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/modsec_batch_settings":{"get":{"description":"This function adds, updates, and removes global ModSecurity™ configuration directives.\nThe function modifies these directives in the `/usr/local/apache/conf/modsec2.cpanel.conf`\nfile.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles/#roles),\nthe system **disables** this function.\n\nThis function **only** supports the following ModSecurity™ configuration directives:\n\n<table>\n <tr><th>setting_id</th><th>Documentation</th></tr>\n <tr><td>0</td><td><a href=\"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secauditengine\">SecAuditEngine</a></td></tr>\n <tr><td>1</td><td><a href=\"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secconnengine\">SecConnEngine</a></td></tr>\n <tr><td>2</td><td><a href=\"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secruleengine\">SecRuleEngine</a></td></tr>\n <tr><td>3</td><td><a href=\"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secdisablebackendcompression\">SecDisableBackendCompression</a></td></tr>\n <tr><td>4</td><td><a href=\"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secgeolookupdb\">SecGeoLookupDb</a></td></tr>\n <tr><td>5</td><td><a href=\"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secgsblookupdb\">SecGsbLookupDb</a></td></tr>\n <tr><td>6</td><td><a href=\"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secguardianlog\">SecGuardianLog</a></td></tr>\n <tr><td>7</td><td><a href=\"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#sechttpblkey\">SecHttpBlKey</a></td></tr>\n <tr><td>8</td><td><a href=\"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secpcrematchlimit\">SecPcreMatchLimit</a></td></tr>\n <tr><td>9</td><td><a href=\"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual-%28v2.x%29#secpcrematchlimitrecursion\">SecPcreMatchLimitRecursion</a></td></tr>\n</table>","operationId":"modsec_batch_settings","parameters":[{"description":"The configuration setting's ID.\n\n**Note:**\n\nTo configure multiple IDs, increment the parameter name. For example, `setting_id1`,\n`setting_id2`, and `setting_id3`.","examples":{"multiple":{"summary":"Set or update multiple configuration settings, in this case: SecConnEngine, SecRuleEngine, and SecDisableBackendCompression.","value":"setting_id1=1 setting_id2=2 setting_id3=3"},"single":{"summary":"Set or update a single configuration setting, in this case for SecConnEngine.","value":1}},"in":"query","name":"setting_id","required":true,"schema":{"maximum":9,"minimum":0,"type":"integer"}},{"description":"The configuration setting's current state.\n\n* `On`\n* `Off`\n\nSome settings accept additional values for this parameter. See the references above for more inforamation.\n\n**Note:**\n\n* To configure multiple settings, increment the parameter name. For example, `state1`,\n`state2`, and `state3`.\n* `state` is ignored if `remove` is set to `1` for the setting.","examples":{"multiple":{"summary":"Set the state of multiple configuration settings.","value":"state1=On state2=On state3=Off"},"single":{"summary":"Set the state of a single configuration setting.","value":"On"}},"in":"query","name":"state","required":true,"schema":{"anyOf":[{"enum":["On","Off"],"type":"string"},{"enum":["On","Off","DetectionOnly"],"type":"string"},{"enum":["On","Off","RelevantOnly"],"type":"string"},{"type":"string"},{"type":"integer"}]}},{"description":"Whether to add or remove the configuration setting in the\n`/usr/local/apache/conf/modsec2.cpanel.conf` file.\n\n* `1` — Remove the configuration setting.\n* `0` — Add or update the configuration setting.\n\n* To remove multiple settings, increment the parameter name. For example, `remove1`,\n`remove2`, and `remove3`.","examples":{"multiple":{"summary":"Remove some settings when updating or setting multiple configuration settings. This example removes the second setting indicated in `setting_id2` and updates the other two settings.","value":"remove1=0 remove2=1 remove3=0"},"single":{"summary":"Remove a single configuration setting requested in the `setting_id`","value":1}},"in":"query","name":"remove","required":false,"schema":{"default":0,"enum":[1,0],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"updated_settings":{"description":"An array of objects that contains the configuration setting's information.","items":{"properties":{"default":{"description":"The setting's default value.\n\n**Note:**\n\nThe `modsec2.cpanel.conf` file defines this value.","example":1500,"minimum":1,"type":"integer"},"description":{"description":"The setting's description.","example":"define the match limit of the PCRE library.","type":"string"},"directive":{"description":"The setting's Apache configuration directive.","example":"SecAuditEngine","type":"string"},"engine":{"description":"Whether the setting is an engine directive.\n\n* `1` — Engine directive.\n* `0` — Normal directive.","enum":[1,0],"example":1,"type":"integer"},"name":{"description":"The setting's name.","example":"Audit Log Level","type":"string"},"radio_options":{"description":"An array of objects that contain the setting's options display information.","items":{"properties":{"name":{"description":"The option's display name.","example":"Log all transactions.","type":"string"},"option":{"description":"The option.","example":"On","type":"string"}},"type":"object"},"type":"array"},"setting_id":{"description":"The setting ID.","example":1,"minimum":1,"type":"integer"},"state":{"description":"The setting's current state, as set by the `state` parameter's input value.","example":"On","type":"string"},"type":{"description":"The form element that the WHM interface uses to display this setting.\n\n* `text` — WHM users modify this setting via a text box.\n* `radio` — WHM users modify this setting via a radio button.\n* `number` — WHM users modify this setting via a text box that **only**\nallows numeric values.","example":"radio","type":"string"},"url":{"description":"The URL of the setting's entry in the ModSecurity reference manual.","example":"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secpcrematchlimit","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_batch_settings","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Run ModSecurity batch settings","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_batch_settings \\\n setting_id='1' \\\n state='On'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_batch_settings?api.version=1&setting_id=1&state=On"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_check_rule":{"get":{"description":"This function checks a ModSecurity™ rule's validity.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_check_rule","parameters":[{"description":"The ModSecurity rule to check.","in":"query","name":"rule","required":true,"schema":{"example":"SecAction \"pass,id:1234567\"","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"problem":{"description":"A string that describes any errors with the ModSecurity\nrule.\n\n**Note:**\n\nThe function only returns this value if an error occurred.","example":"The rule is invalid. Apache returned the following error: AH00526: Syntax error on line 1 of /var/tmp/15500._USR_LOCAL_CPANEL_WHOSTMGR_BIN_XML_API__.gl2t8wZ1.tmp/validate.conf:\nInvalid command ''OWASP'', perhaps misspelled or defined by a module not included in the server configuration\n'","type":"string"},"valid":{"description":"Whether the rule is valid.\n\n* `1` — Valid rule.\n* `0` — Invalid rule.","enum":[1,0],"example":0,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_check_rule","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK Invalid Rule","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate ModSecurity rule","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_check_rule \\\n rule='SecAction \"pass,id:1234567\"'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_check_rule?api.version=1&rule=SecAction%20%22pass%2cid%3a1234567%22"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_clone_rule":{"get":{"description":"This function copies a ModSecurity™ rule with a new rule ID.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_clone_rule","parameters":[{"description":"The rule's ModSecurity configuration file.","in":"query","name":"config","required":true,"schema":{"example":"modsec2.user.conf","type":"string"}},{"description":"The existing rule's ID.","in":"query","name":"id","required":true,"schema":{"example":123456789,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"rule":{"description":"A list of information about the cloned ModSecurity rule.","properties":{"config":{"description":"The rule's ModSecurity configuration file.","example":"modsec2.user.conf","type":"string"},"config_active":{"description":"Whether the configuration file is active.\n\n* `1` — Active.\n* `0` — **Not** active.","enum":[1,0],"example":1,"type":"integer"},"disabled":{"description":"Whether the rule is disabled.\n\n* `1` — Disabled.\n* `0` — Enabled.","enum":[1,0],"example":0,"type":"integer"},"id":{"description":"The rule's ID number.","example":123456789,"minimum":1,"type":"integer"},"meta_msg":{"description":"The rule's description.","example":"Rejected request","type":"string"},"rule":{"description":"The rule's text that includes the new rule ID.","example":"SecRule REQUEST_URI \"/rejected.php\" \"deny,auditlog,msg:'Rejected request',id:'1'\"","type":"string"},"staged":{"description":"Whether the rule is staged.\n\n* `1` — Staged.\n* `0` — **Not** staged.","enum":[1,0],"example":1,"type":"integer"},"vendor_active":{"description":"Whether the vendor is active.\n\n* `1` — Active.\n* `0` — **Not** active.","enum":[1,0],"example":0,"type":"integer"},"vendor_id":{"description":"The vendor's unique short name.\n\n**Note:**\n\nAny rule that does not belong to a vendor rule set will **not**\nreturn a value.","example":"YourVendor","type":"string"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_clone_rule","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Save ModSecurity rule copy","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_clone_rule \\\n config='modsec2.user.conf' \\\n id='123456789'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_clone_rule?api.version=1&config=modsec2.user.conf&id=123456789"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/purchase_a_license":{"get":{"description":"This function returns the checkout URL to use for a cPanel Store or cPanel Market provider purchase.","operationId":"purchase_a_license","parameters":[{"description":"The cPanel Store or cPanel Market provider's name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}},{"description":"The location to which the cPanel Store or cPanel Market provider directs the user after the checkout process finishes.","in":"query","name":"url_after_checkout","required":true,"schema":{"example":"http://hostname.example.com","format":"url","type":"string"}},{"description":"The login token to access the cPanel Store.","in":"query","name":"login_token","required":true,"schema":{"example":"1a676e6f-99fc-11e6-9ab6-e60a769b73bc","type":"string"}},{"description":"Whether the cPanel Store or cPanel Market provider should treat this request as an upgrade.\n* `1` — An upgrade.\n* `0` — **Not** an upgrade.","in":"query","name":"upgrade","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of checkout URLs. A valid checkout URL.","items":{"example":"https://store.cpanel.net/checkout/ssl/1234567","type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"purchase_a_license","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed .Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel Store or Market checkout URL","tags":["Server Administration","License Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n purchase_a_license \\\n provider='cPStore' \\\n url_after_checkout='http://hostname.example.com' \\\n login_token='1a676e6f-99fc-11e6-9ab6-e60a769b73bc'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/purchase_a_license?api.version=1&provider=cPStore&url_after_checkout=http%3a%2f%2fhostname.example.com&login_token=1a676e6f-99fc-11e6-9ab6-e60a769b73bc"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"62"}},"/modsec_deploy_all_rule_changes":{"get":{"description":"This function deploys the staged changes for all of the ModSecurity™ configuration files\ninto the live configuration files. After the function deploys the configuration files, it\nrestarts Apache. If the new configuration is invalid, the system restores the original\nconfiguration and preserves the staged changes.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_deploy_all_rule_changes","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"failed":{"description":"The list of configuration files that the system could not deploy.\n\n**Note:**\n\nThe function **only** returns this value if an error occurs.","items":{"example":"modsec_vendor_configs/MyVendor/one.conf","type":"string"},"type":"array"},"outcomes":{"description":"An array of objects containing information about the configuration deployment.","items":{"properties":{"config":{"description":"The file path to the configuration file.\n\n* EasyApache 4 — A valid path, relative to the `/etc/apache2/conf.d/modsec/` directory.","example":"modsec_vendor_configs/MyVendor/one.conf","type":"string"},"exception":{"description":"The error message for a failed deployment.\n\n**Note:**\n\nThe function only returns this output if an error occurs.","example":"The system could not deploy changes for modsec_vendor_configs/MyVendor/one.conf: The system could not validate the new Apache configuration, because httpd exited with a nonzero value. Apache produced the following error: httpd: Syntax error on line 37 of /usr/local/apache/conf/httpd.conf: Syntax error on line 26 of /usr/local/apache/conf/modsec2.conf: Syntax error on line 27 of /usr/local/apache/conf/modsec2.cpanel.conf: Could not open configuration file /usr/local/apache/conf/modsec_vendor_configs/MyVendor/one.conf: No such file or directory\n\n\n","type":"string"},"ok":{"description":"Whether the rule change deployment succeeded.\n\n* `1` — Successful deployment.\n* `0` — Unsuccessful deployment.","enum":[1,0],"example":0,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_deploy_all_rule_changes","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable all staged ModSecurity rule changes","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_deploy_all_rule_changes\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_deploy_all_rule_changes?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/modsec_deploy_rule_changes":{"get":{"description":"This function deploys staged changes to the ModSecurity™ configuration file and restarts\nApache.\n\n**Note:**\n\nIf the new configuration is invalid, the system will restore the original configuration\nand maintain the staged changes.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_deploy_rule_changes","parameters":[{"description":"The ModSecurity configuration file's path and name, relative to the `/usr/local/apache/conf/` directory.","in":"query","name":"config","required":true,"schema":{"example":"modsec_vendor_configs/example.conf","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_deploy_rule_changes","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable staged ModSecurity rule changes","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_deploy_rule_changes \\\n config='modsec_vendor_configs/example.conf'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_deploy_rule_changes?api.version=1&config=modsec_vendor_configs%2fexample.conf"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/validate_login_token":{"get":{"description":"This function validates a login token with the cPanel Store or a cPanel Market provider, and then returns access tokens.","operationId":"validate_login_token","parameters":[{"description":"The cPanel Store or cPanel Market provider's name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}},{"description":"The location to which the cPanel Store or cPanel Market provider redirects the user's browser after they log in.","in":"query","name":"url_after_login","required":true,"schema":{"example":"http://hostname.example.com/redirectionlocation.cgi?state","format":"url","type":"string"}},{"description":"The login token to validate.","in":"query","name":"login_token","required":true,"schema":{"example":"1a676e6f-99fc-11e6-9ab6-e60a769b73bc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"payload":{"description":"An array of objects that contain token information.","items":{"properties":{"access_token":{"description":"The access token that the cPanel Store or cPanel Market provider returns after you log in.","example":"b7a6f029-99fc-11e6-a0bd-87581cb027ac","type":"string"},"refresh_token":{"description":"The refresh token that the cPanel Store or cPanel Market provider returns after you log in .","example":"b7a7107f-99fc-11e6-a0bd-b46329164206","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"validate_login_token","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the 'reason' field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate login token and return access token","tags":["Authentication","Market Integration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n validate_login_token \\\n provider='cPStore' \\\n url_after_login='http://hostname.example.com/redirectionlocation.cgi?state' \\\n login_token='1a676e6f-99fc-11e6-9ab6-e60a769b73bc'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/validate_login_token?api.version=1&provider=cPStore&url_after_login=http%3a%2f%2fhostname.example.com%2fredirectionlocation.cgi%3fstate&login_token=1a676e6f-99fc-11e6-9ab6-e60a769b73bc"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"62"}},"/modsec_disable_vendor_configs":{"get":{"description":"This function disables a ModSecurity™ vendor's configuration files.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_disable_vendor_configs","parameters":[{"description":"The vendor's unique short name.","in":"query","name":"vendor_id","required":true,"schema":{"example":"SomeVendor","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"outcomes":{"description":"An array of objects containing elements that represent the outcome of each attempt to disable an operation.","items":{"properties":{"active":{"description":"Whether the configuration file is active.\n\n* `1` — Active.\n* `0` — **Not** active.","enum":[1,0],"example":1,"type":"integer"},"config":{"description":"The configuration file path, relative to the `/usr/local/apache/conf/` directory.","example":"modsec_vendor_configs/SomeVendor/example.conf","type":"string"},"exception":{"description":"If the function fails to disable the configuration file, this\nreturn contains the error message.\n\n**Note:**\n\nThis function only returns a value if an error occurred.","example":"This is an error message.","type":"string"},"ok":{"description":"Whether the function successfully disabled the configuration file.\n\n* `1` — Disabled.\n* `0` — Enabled.","enum":[1,0],"example":0,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_disable_vendor_configs","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable ModSecurity vendor configuration files","tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_disable_vendor_configs \\\n vendor_id='SomeVendor'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_disable_vendor_configs?api.version=1&vendor_id=SomeVendor"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/modsec_discard_all_rule_changes":{"get":{"description":"This function discards the staged ModSecurity™ rule changes, if present, for all of\nthe configuration files.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_discard_all_rule_changes","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"failed":{"description":"The list of configuration files that contain changes that the system\ncould not discard.\n\n**Note:**\n\nThe function **only** returns this value if an error occurs.","items":{"example":"modsec_vendor_configs/MyVendor/one.conf","format":"path","type":"string"},"type":"array"},"outcomes":{"description":"An array of objects containing information about the discarded configuration changes.","items":{"properties":{"config":{"description":"The file path to the configuration file.\n\n* EasyApache 4 — A valid path, relative to the `/etc/apache2/conf.d/modsec/` directory.","example":"modsec_vendor_configs/MyVendor/one.conf","type":"string"},"exception":{"description":"The error message for a failed discard.\n\n**Note:**\n\n The function only returns this value if an error occurs. The reason for failure.","example":"The system could not remove the file /usr/local/apache/conf/modsec_vendor_configs/MyVendor/one.conf.STAGE: Invalid argument\n","type":"string"},"ok":{"description":"Whether the system successfully discarded the rule change.\n\n* `1` — Success.\n* `0` — Failure.","enum":[1,0],"example":0,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_discard_all_rule_changes","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove all staged ModSecurity rule changes","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_discard_all_rule_changes\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_discard_all_rule_changes?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/modsec_disable_rule":{"get":{"description":"This function disables a ModSecurity™ rule.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_disable_rule","parameters":[{"description":"The ModSecurity configuration file, relative to the `/etc/apache2/conf.d` directory.","in":"query","name":"config","required":true,"schema":{"example":"modsec_vendor_configs/example.conf","type":"string"}},{"description":"The ModSecurity rule's ID.","in":"query","name":"id","required":true,"schema":{"example":"1234567890","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_disable_rule","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable ModSecurity rule","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_disable_rule \\\n config='modsec_vendor_configs/example.conf' \\\n id='1234567890'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_disable_rule?api.version=1&config=modsec_vendor_configs%2fexample.conf&id=1234567890"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_disable_vendor_updates":{"get":{"description":"This function disables automatic updates for a ModSecurity™ vendor.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_disable_vendor_updates","parameters":[{"description":"The vendor's unique short name.","in":"query","name":"vendor_id","required":true,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_disable_vendor_updates","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable ModSecurity vendor updates","tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_disable_vendor_updates \\\n vendor_id='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_disable_vendor_updates?api.version=1&vendor_id=example"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/modsec_discard_rule_changes":{"get":{"description":"This function discards staged rule changes for a ModSecurity™ configuration file.\nStaged rule changes reside in a `.STAGE` file (for example, the staged changes for\nthe `example.conf` file exist in the `example.conf.STAGE` file).\nThis function deletes the `.STAGE` file that corresponds to the configuration file that\nyou specify.\n\n**Note:**\n\nTo stage rule changes, call WHM API 1's `modsec_add_rule` function.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_discard_rule_changes","parameters":[{"description":"The ModSecurity configuration file in the `/usr/local/cpanel/apache/conf/` directory.","in":"query","name":"config","required":true,"schema":{"example":"modsec2.example.conf","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_discard_rule_changes","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove staged ModSecurity rule changes","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_discard_rule_changes \\\n config='modsec2.example.conf'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_discard_rule_changes?api.version=1&config=modsec2.example.conf"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_enable_vendor":{"get":{"description":"This function enables a ModSecurity™ vendor rule set.\n\n**Note:**\n\nThis function will **not** enable vendor configuration files that you individually\ndisable.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_enable_vendor","parameters":[{"description":"The vendor's unique short name.","in":"query","name":"vendor_id","required":true,"schema":{"example":"SomeVendor","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_enable_vendor","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable ModSecurity vendor rules","tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_enable_vendor \\\n vendor_id='SomeVendor'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_enable_vendor?api.version=1&vendor_id=SomeVendor"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/modsec_enable_vendor_configs":{"get":{"description":"This function enables a ModSecurity™ vendor's configuration files.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_enable_vendor_configs","parameters":[{"description":"The vendor's unique short name.","in":"query","name":"vendor_id","required":true,"schema":{"example":"SomeVendor","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"outcomes":{"description":"An array of objects containing elements that represent the outcome of each attempt to enable operation.","items":{"properties":{"active":{"description":"Whether the configuration file is active.\n\n* `1` — Active.\n* `0` — **Not** active.","enum":[1,0],"example":1,"type":"integer"},"config":{"description":"The configuration file path, relative to the `/usr/local/apache/conf/` directory.","example":"modsec_vendor_configs/SomeVendor/example.conf","type":"string"},"exception":{"description":"If the function fails to enable the configuration file, this return\ncontains the error message.\n\n**Note:**\n\nThe function **only** returns a value if an error occurred.","example":"This is an error message.","type":"string"},"ok":{"description":"Whether the function successfully enabled the configuration file.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_enable_vendor_configs","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable ModSecurity vendor configuration files","tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_enable_vendor_configs \\\n vendor_id='SomeVendor'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_enable_vendor_configs?api.version=1&vendor_id=SomeVendor"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/modsec_enable_vendor_updates":{"get":{"description":"This function enables automatic updates for a ModSecurity™ vendor.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_enable_vendor_updates","parameters":[{"description":"The vendor's unique short name.","in":"query","name":"vendor_id","required":true,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_enable_vendor_updates","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable ModSecurity vendor updates","tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_enable_vendor_updates \\\n vendor_id='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_enable_vendor_updates?api.version=1&vendor_id=example"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/modsec_get_config_text":{"get":{"description":"This function retrieves a ModSecurity™ configuration file's contents.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_get_config_text","parameters":[{"description":"The ModSecurity configuration file's name.","in":"query","name":"config","required":true,"schema":{"example":"modsec2.example.conf","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"text":{"description":"The ModSecurity configuration file's contents.","example":"SecRule REQUEST_URI \"example\" \"deny:id:123456789\" SecAction \"pass:auditlog:id:444444444\"","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_get_config_text","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return ModSecurity configuration file","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_get_config_text \\\n config='modsec2.example.conf'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_config_text?api.version=1&config=modsec2.example.conf"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_edit_rule":{"get":{"description":"This function stages edits to a ModSecurity™ rule. The system does **not** save changes\ndirectly to the configuration file. Instead, it stages the changes to the configuration\nfile's `.STAGE` file (for example, for the `example.conf` file, the system stages changes\nin the `example.conf.STAGE` file).\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_edit_rule","parameters":[{"description":"The ModSecurity configuration file, relative to the `/usr/local/apache/conf/` directory.","in":"query","name":"config","required":true,"schema":{"example":"modsec_vendor_configs/example.conf","type":"string"}},{"description":"The ModSecurity rule's ID.","in":"query","name":"id","required":true,"schema":{"example":1234567,"type":"integer"}},{"description":"The new ModSecurity rule.","in":"query","name":"rule","required":true,"schema":{"example":"SecAction \"pass,id:1234567\"","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"rule":{"description":"A list of information about the new ModSecurity rule.","properties":{"disabled":{"description":"Whether the ModSecurity rule is disabled.\n\n* `1` — Disabled.\n* `0` — Enabled.","enum":[1,0],"example":0,"type":"integer"},"id":{"description":"The ModSecurity rule's ID.","example":1234567,"minimum":1,"type":"integer"},"meta_msg":{"description":"The ModSecurity rule's description, if one exists.","example":"","type":"string"},"rule":{"description":"The ModSecurity rule's text.","example":"SecAction \"pass,id:1234567\"","type":"string"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_edit_rule","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update staged ModSecurity rule","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_edit_rule \\\n config='modsec_vendor_configs/example.conf' \\\n id='1234567' \\\n rule='SecAction \"pass,id:1234567\"'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_edit_rule?api.version=1&config=modsec_vendor_configs%2fexample.conf&id=1234567&rule=SecAction%20%22pass%2cid%3a1234567%22"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_get_configs":{"get":{"description":"This function lists ModSecurity™ configuration files. The system stores the configuration\nfiles in the `/usr/local/apache/conf/modsec_vendor_configs` directory.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_get_configs","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"configs":{"description":"An array of objects containing information about ModSecurity configuration files.","items":{"properties":{"active":{"description":"Whether the configuration file is active.\n\n* `1` — Active.\n* `0` — **Not** active.\n\n**Note:**\n\nThe file is active if an include for the configuration file appears\nin the `modsec2.cpanel.conf` file.","enum":[1,0],"example":1,"type":"integer"},"config":{"description":"The configuration file's location, relative to the `/usr/local/apache/conf` directory.","example":"modsec_vendor_configs/MyVendor/one.conf","type":"string"},"vendor_id":{"description":"The vendor's unique short name.","example":"MyVendor","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_get_configs","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all ModSecurity configuration files","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_get_configs\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_configs?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/modsec_get_configs_with_changes_pending":{"get":{"description":"This function lists the ModSecurity™ configuration files that have staged changes.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_get_configs_with_changes_pending","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"configs":{"description":"An array of strings containing one or more ModSecurity configuration files.","example":["modsec2.user.conf","modsec2.user1.conf","modsec2.user2.conf"],"items":{"type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_get_configs_with_changes_pending","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return staged ModSecurity configuration files","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_get_configs_with_changes_pending\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_configs_with_changes_pending?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_get_log":{"get":{"description":"This function retrieves ModSecurity™ log entries from the modsec MySQL® database.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system disables this function.","operationId":"modsec_get_log","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"description":"An array of objects that contains information about the log entry.","items":{"properties":{"action_desc":{"description":"The web server's response to the client.","example":"Access denied with code 406 (phase 1).","type":"string"},"file_exists":{"description":"Whether the file in the `meta_file` return exists.\n\n* `1` — The file exists.\n* `0` — The files does **not** exist.","enum":[1,0],"example":1,"type":"integer"},"handler":{"description":"This parameter **only** returns the `null` value.","example":null,"nullable":true,"type":"string"},"host":{"description":"The virtual host's (vhost) domain name.","example":"server.example.com","type":"string"},"http_method":{"description":"The\n[HTTP method](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)\nthat the client used to generate the hit.","example":"GET","type":"string"},"http_status":{"description":"The\n[HTTP status code](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html)\nthat the web server returned.","example":406,"type":"integer"},"http_version":{"description":"The HTTP version number.","example":"HTTP/1.1","type":"string"},"id":{"description":"The line number from the `modsec` database.","example":28,"minimum":1,"type":"integer"},"ip":{"description":"The client's IP address.","example":"10.1.14.77","format":"ipv4","type":"string"},"justification":{"description":"The specific criteria from the ModSecurity rule that generated the hit.","example":"Match of \"within %{tx.allowed_methods}\" against \"REQUEST_METHOD\" required.","type":"string"},"meta_file":{"description":"The ModSecurity configuration file with the rule that triggered the log entry.","example":"/usr/local/apache/conf/modsec_vendor_configs/OWASP/base_rules/modsecurity_crs_30_http_policy.conf","type":"string"},"meta_id":{"description":"The ID of the ModSecurity rule that triggered the log entry.","example":960032,"type":"integer"},"meta_line":{"description":"The ModSecurity rule's line number that triggered the log entry.","example":31,"minimum":1,"type":"integer"},"meta_logdata":{"description":"The transaction data fragment from the ModSecurity rule's logdata action.","example":"GET","nullable":true,"type":"string"},"meta_msg":{"description":"The human-readable message from the ModSecurity rule's `msg` action.","example":"Method is not allowed by policy","type":"string"},"meta_offset":{"description":"The byte offset at which a match occurred within the target data.\n\n**Note:**\n\nThis data is not always available.","example":0,"type":"integer"},"meta_rev":{"description":"The revision number from the ModSecurity rule's `rev` action.","example":2,"nullable":true,"type":"integer"},"meta_severity":{"description":"The hit severity level from the ModSecurity rule's `severity` action.","example":"CRITICAL","nullable":true,"type":"string"},"meta_uri":{"description":"The client-requested URI.\n\n**Note:**\n\nThis data is not always available.","example":null,"format":"uri","nullable":true,"type":"string"},"path":{"description":"The accessed file's absolute path and filename.","example":"/favicon.ico","type":"string"},"reportable":{"description":"Whether the system can report the rule to the vendor.\n\n* `1` — Report the rule to the vendor.\n* `0` — Do **not** report the rule to the vendor.\n\n**Note:**\n\nThe vendor **must** have configured a report URL in order to\nreport a rule.","enum":[1,0],"example":1,"type":"integer"},"timestamp":{"description":"When the system recorded the log entry, in `YYYY-MM-DD HH:mm:SS` format.\n\n**Note:**\n\nThis value uses the server's configured time zone.","example":"2019-10-13T07:58:04","format":"ISO-8601 Date Time","type":"string"},"timezone":{"description":"The server's configured timezone, in minutes difference UTC/GMT format.","example":-300,"type":"integer"}},"type":"object"},"type":"array"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_get_log","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return ModSecurity logs","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_get_log\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_log?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_get_settings":{"get":{"description":"This function retrieves the server's ModSecurity™ configuration settings. The system\nstores these settings in the `/usr/local/apache/conf/modsec2.conf` file.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/serverroles#roles),\nthe system **disables** this function.","operationId":"modsec_get_settings","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"settings":{"description":"An array of objects containing ModSecurity global configuration settings.","example":[{"default":"Off","description":"This setting controls the behavior of the audit engine.","directive":"SecAuditEngine","engine":1,"missing":1,"name":"Audit Log Level","radio_options":[{"name":"Log all transactions.","option":"On"},{"name":"Do not log any transactions.","option":"Off"},{"name":"Only log noteworthy transactions.","option":"RelevantOnly"}],"setting_id":0,"state":"","type":"radio","url":"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secauditengine"},{"description":"Specify an external program to pipe transaction log information to for additional analysis. The syntax is analogous to the .forward file, in which a pipe at the beginning of the field indicates piping to an external program.","directive":"SecGuardianLog","missing":1,"name":"Guardian Log","setting_id":6,"state":"","type":"text","url":"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secguardianlog","validation":[{"arg":"[|]","name":"startsWith"},"path"]}],"items":{"properties":{"default":{"description":"The setting's default value.","oneOf":[{"type":"string"},{"minimum":0,"type":"integer"}]},"description":{"description":"The setting's description. The user's\n[locale](https://go.cpanel.net/locale) may translate this value.","type":"string"},"directive":{"description":"The setting's Apache® configuration directive.","type":"string"},"engine":{"description":"Whether the setting is an engine directive. If the setting is\na normal directive, the function does **not** return this value.\n\n* `1` — Engine directive.","enum":[1],"type":"integer"},"missing":{"description":"Whether the setting is missing.\n\n* `1` — The value is missing.","enum":[1],"type":"integer"},"name":{"description":"The setting's name.","type":"string"},"radio_options":{"description":"An array of objects containing the options that the client should\ndisplay, as radio buttons, for this setting in a user interface.\n\n**Note:**\n\nThe function **only** returns this value when the `type`\nparameter is the `radio` values.","items":{"properties":{"name":{"description":"The setting name to display to the user. The user's\n[locale](https://go.cpanel.net/locale) may translate this value.","type":"string"},"option":{"description":"The setting that the system used to select the setting's state.\n\n**Note:**\n\nThis value is identical to the string that the client sends in\nas the `state` value when users select the specified setting. In most\ncases, you should **not** display this value to the user. Instead,\ndisplay the `name` value.","type":"string"}},"type":"object"},"type":"array"},"setting_id":{"description":"The setting ID.","minimum":0,"type":"integer"},"state":{"description":"The setting's current state, if available.","type":"string"},"type":{"description":"The form element that the WHM interface uses to display this setting.\n\n* `text` — WHM users modify this setting via a text box.\n* `radio` — WHM users modify this setting via a radio button.\n* `number` — WHM users modify this setting via a text box that\nonly allows numeric values.","enum":["text","radio","number"],"type":"string"},"url":{"description":"The URL of the setting's entry in the ModSecurity reference manual.","format":"url","type":"string"},"validation":{"description":"A list of validators to apply when updating the state. Use these validators\nto perform frontend validation through your preferred implementation\nmethods.\n\n**Note:**\n\nThe function may represent each validator as either a string or an\nobject.\n\n* When the function represents the validator as a string, no arguments\nexist for the validator.\n* When the function returns the validator as a object, the API may\nalso include an argument for the validator.","items":{"anyOf":[{"description":"An object that contains the validation rule and arguments.","properties":{"arg":{"description":"The regular expression pattern that is used with the validator identified in the `name` property.","type":"string"},"name":{"description":"One of the following validators:\n\n* `startsWith` - Check if the updated `state` starts with the pattern passed in `arg`.","enum":["startsWith","endsWith"],"type":"string"}},"type":"object"},{"description":"One of the following validators:\n\n* `path` — An instruction to verify whether the user's input is a\nvalid path.\n* `honeypotAccessKey` — An instruction to verify whether the user's\ninput fits the constraints of an `Http:BL` API access key.\n* `positiveInteger` — An instruction to verify whether the user's\ninput is a positive integer.","enum":["path","honeypotAccessKey","positiveInteger"],"type":"string"}]},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_get_settings","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return ModSecurity configuration","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_get_settings\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_settings?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_get_rules":{"get":{"description":"This function retrieves the ModSecurity™ rules from one or more ModSecurity configuration files.\n\n**Important:**\n\n* When you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system disables this function.\n* You **must** include either the `vendor_id` **or** the `config` parameters.","operationId":"modsec_get_rules","parameters":[{"description":"The vendor's unique short name.\n\n**Note:**\n\nYou can use a comma-delimited list for multiple vendors.","examples":{"multiple":{"summary":"Call multiple vendors.","value":"vendor=SomeVendor,AnotherVendor"},"single":{"summary":"Call a single vendor.","value":"SomeVendor"}},"in":"query","name":"vendor_id","required":false,"schema":{"type":"string"}},{"description":"The file path to the configuration file, relative to the `/usr/local/apache/conf` directory.\n\n**Note:**\n\nYou can use a comma-delimited list for multiple configuration files.","examples":{"multiple":{"summary":"Call multiple configuration files.","value":"modsec_vendor_configs/SomeVendor/config.conf,modsec_vendor_configs/AnotherVendor/config.conf"},"single":{"summary":"Call a single configuration file.","value":"modsec_vendor_configs/SomeVendor/config.conf"}},"in":"query","name":"config","required":false,"schema":{"type":"string"}},{"description":"Whether the function only returns the `SecRule` and `SecAction` directives\nfrom the configuration file, and comments that are not associated with a\nrule.\n\n* `1` — Only return the `SecRule` and `SecAction` directives and comments **not**\nassociated with a rule.\n* `0` — Return **all** directives and comments.","in":"query","name":"exclude_other_directives","required":false,"schema":{"default":1,"enum":[1,0],"example":1,"type":"integer"}},{"description":"Whether to exclude comments that are not associated with any directives.\n\n* `1` — Exclude.\n* `0` — Do **not** exclude.","in":"query","name":"exclude_bare_comments","required":false,"schema":{"default":1,"enum":[1,0],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"chunks":{"description":"An array of objects that contains elements that represent the contents of each configuration file's rules.","items":{"properties":{"config":{"description":"The file path to the configuration file, relative to the `/usr/local/apache/conf/` directory.","example":"modsec_vendor_configs/SomeVendor/config.conf","type":"string"},"config_active":{"description":"Whether the configuration file is active.\n\n* `1` — Active.\n* `0` — **Not** active.","enum":[1,0],"example":0,"type":"integer"},"disabled":{"description":"Whether the rule is active.\n\n* `1` — **Not** Active.\n* `0` — Active.","enum":[1,0],"example":0,"type":"integer"},"id":{"description":"The ModSecurity rule's ID number.\n\n**Note:**\n\nThe function does not always return this parameter.","example":662452,"minimum":1,"type":"integer"},"meta_msg":{"description":"The description of the rule.","example":"Denied dangerous config traffic","type":"string"},"rule":{"description":"The rule's text.\n\n**Note:**\n\nThis return may include multiple directives and comments if they\nare all part of the same rule.","example":"SecRule REQUEST_FILENAME \"config\" \"deny,id:662452,msg:'Denied dangerous config traffic',severity:1,auditlog\"","type":"string"},"staged":{"description":"Whether the system has added the rule to the ModSecurity configuration file.\n\n* `1` — Rule staged.\n* `0` — Rule **not** staged.","enum":[1,0],"example":0,"type":"integer"},"vendor_active":{"description":"Whether the vendor is active.\n\n* `1` — Active.\n* `0` — **Not** active.","enum":[1,0],"example":0,"type":"integer"},"vendor_id":{"description":"The vendor's unique short name.","example":"SomeVendor","type":"string"}},"type":"object"},"type":"array"},"staged_changes":{"description":"Whether the chunks array includes staged changes that the system has not\nyet added to the ModSecurity configuration file.\n\n* `1` — Staged changes in output.\n* `0` — **No** staged changes in output.","enum":[1,0],"example":0,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_get_rules","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return ModSecurity rules","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_get_rules\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_rules?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/modsec_get_vendors":{"get":{"description":"The function returns a list of configured ModSecurity™ vendors.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_get_vendors","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"vendors":{"description":"An array of objects that represent the list of configured vendors on the system.","items":{"properties":{"archive_url":{"description":"The URL to download the vendor rules.","example":"http://www.example.com/SAMPLE_1415038544.zip","format":"url","type":"string"},"configs":{"description":"A list of information about the configuration files that the vendor provides.","example":[{"active":1,"config":"modsec_vendor_configs/SAMPLE/modsecurity_crs_10_setup.conf","vendor_id":"SAMPLE"},{"active":0,"config":"modsec_vendor_configs/SAMPLE/optional_rules/modsecurity_crs_16_session_hijacking.conf","vendor_id":"SAMPLE"},{"active":1,"config":"modsec_vendor_configs/SAMPLE/optional_rules/modsecurity_crs_46_av_scanning.conf","vendor_id":"SAMPLE"}],"items":{"properties":{"active":{"description":"Whether the configuration is active.\n\n* `1` — Active.\n* `0` — Inactive.","enum":[1,0],"example":1,"type":"integer"},"config":{"description":"The configuration file path, relative to the `/usr/local/apache/conf` directory.","example":"modsec_vendor_configs/SAMPLE/slr_rules/modsecurity_crs_46_slr_et_joomla_attacks.conf","type":"string"},"vendor_id":{"description":"The vendor's unique short name.","example":"SAMPLE","type":"string"}},"type":"object"},"type":"array"},"cpanel_provided":{"description":"Whether cPanel & WHM installed the vendor rule set.\n\n* `1` — Installed.\n* `0` — **Not** installed.","enum":[1,0],"example":0,"type":"integer"},"description":{"description":"The ModSecurity vendor's description.","example":"A SAMPLE-curated ModSecurity rule set.","type":"string"},"dist_md5":{"description":"The download's [MD5](https://en.wikipedia.org/wiki/MD5)\nchecksum value.","example":"ffbaa3a7ead8dfaf0b661a729ce6ad3b","type":"string"},"dist_sha512":{"description":"The download's [sha512](https://en.wikipedia.org/wiki/SHA-2) hash.","example":"b55c09bb1835ed4209f0f3ea4a70d099665363f23d3819c0369be429438d675ba2c749dcefdb85cee682ee0bf485558e67d0b0965fe4799865529d943e8e14cb","type":"string"},"enabled":{"description":"Whether the vendor is enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[1,0],"example":1,"type":"integer"},"in_use":{"description":"The number of configuration files in the vendor rule set.","example":32,"minimum":0,"type":"integer"},"inst_dist":{"description":"The rule set version's unique identifier.","example":"SAMPLE_1415038544","type":"string"},"installed":{"description":"Whether the vendor is installed.\n\n* `1` — Installed.\n* `0` — **Not** installed.","enum":[1,0],"example":1,"type":"integer"},"installed_from":{"description":"The URL to the vendor's metadata file.","example":"http://www.example.com/meta_SAMPLE.yaml","type":"string"},"name":{"description":"The vendor's name.","example":"SAMPLE ModSecurity Core Rule Set","type":"string"},"path":{"description":"The full path to the vendor's ModSecurity configuration files.","example":"/usr/local/apache/conf/modsec_vendor_configs/SAMPLE","type":"string"},"report_url":{"description":"The URL of the vendor's Report Receiver API endpoint that reports\nproblems with the vendor's rules.\n\n**Note:**\n\nThe function may not always return this parameter.","example":"https://www.example.com/report","format":"url","type":"string"},"supported_versions":{"description":"A list of the ModSecurity versions that the vendor supports.","example":["2.9.1","2.9.2","2.9.3"],"items":{"type":"string"},"type":"array"},"update":{"description":"Whether the vendor rule set can receive automatic updates.\n\n* `1` — Can receive automatic updates.\n* `0` — **Cannot** receive automatic updates.","enum":[1,0],"example":1,"type":"integer"},"vendor_id":{"description":"The vendor's unique short name.","example":"SAMPLE","type":"string"},"vendor_url":{"description":"The URL of the vendor's website.","example":"https://www.example.com/index.php/Category:SAMPLE_ModSecurity_Core_Rule_Set_Project","format":"url","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_get_vendors","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return ModSecurity vendors","tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_get_vendors\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_vendors?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_is_installed":{"get":{"description":"This function checks whether the ModSecurity™ module is installed.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"modsec_is_installed","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"data":{"properties":{"installed":{"description":"Whether ModSecurity is installed on the server.\n* `1` — Installed.\n* `0` — **Not** installed.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_is_installed","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result`\nfield is `0`. This field may display a success message when\na function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return ModSecurity module status","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_is_installed\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_is_installed?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_make_config_inactive":{"get":{"description":"This function removes an include for a ModSecurity™ configuration file from\nthe `modsec2.cpanel.conf` file. This makes the ModSecurity configuration file\ninactive.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_make_config_inactive","parameters":[{"description":"The ModSecurity configuration file's path and filename, relative to the `/etc/apache2/conf.d/` directory.","in":"query","name":"config","required":true,"schema":{"example":"modsec_vendor_configs/example.conf","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_make_config_inactive","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove ModSecurity configuration file include","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_make_config_inactive \\\n config='modsec_vendor_configs/example.conf'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_make_config_inactive?api.version=1&config=modsec_vendor_configs%2fexample.conf"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_make_config_active":{"get":{"description":"This function adds an include for a ModSecurity™ configuration file to\nthe `modsec2.cpanel.conf` file. This makes the ModSecurity configuration file\nactive.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_make_config_active","parameters":[{"description":"The ModSecurity configuration file's path and filename, relative to the `/usr/local/apache/conf/` diretory.","in":"query","name":"config","required":true,"schema":{"example":"modsec_vendor_configs/example.conf","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_make_config_active","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add ModSecurity configuration file include","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_make_config_active \\\n config='modsec_vendor_configs/example.conf'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_make_config_active?api.version=1&config=modsec_vendor_configs%2fexample.conf"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_disable_vendor":{"get":{"description":"This function disables a ModSecurity™ vendor rule set.\n\n**Note:**\n\nThis function will **not** disable vendor configuration files that you have individually enabled.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_disable_vendor","parameters":[{"description":"The vendor's unique short name.","in":"query","name":"vendor_id","required":true,"schema":{"example":"SomeVendor","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_disable_vendor","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable ModSecurity vendor rules","tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_disable_vendor \\\n vendor_id='SomeVendor'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_disable_vendor?api.version=1&vendor_id=SomeVendor"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/modsec_preview_vendor":{"get":{"description":"This function returns the metadata for a ModSecurity™ vendor rule set.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_preview_vendor","parameters":[{"description":"The YAML metadata's URL, which describes the vendor and how to obtain its rules.\n\n**Note:**\n\n* The file uses YAML format.\n* The filename **must** use the `meta_` prefix.\n* The filename **must** match the `vendor_id` value for your vendor.\n* The filename **must** end with the `.yaml` extension.","in":"query","name":"url","required":true,"schema":{"example":"https://www.example.com/vendor1rules/meta_vendor1.yaml","format":"url","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"archive_url":{"description":"The URL to the vendor's rule set archive.","example":"https://www.example.com/vendor1.zip","format":"url","type":"string"},"cpanel_provided":{"description":"Whether WebPros International, LLC provided the vendor.\n\n* `1` — cPanel-provided.\n* `0` — **Not** cPanel-provided.","enum":[1,0],"example":0,"type":"integer"},"description":{"description":"The vendor's description.","example":"This is the Vendor1 ModSecurity Core Rule Set.","type":"string"},"dist_md5":{"description":"The download's [MD5](https://en.wikipedia.org/wiki/Md5) checksum value.","example":"307cb5320441ebd712e5581d12100dc9","type":"string"},"dist_sha512":{"description":"The download's [sha512](https://en.wikipedia.org/wiki/SHA-2) hash.","example":"b55c09bb1835ed4209f0f3ea4a70d099665363f23d3819c0369be429438d675ba2c749dcefdb85cee682ee0bf485558e67d0b0965fe4799865529d943e8e14cb","type":"string"},"installed":{"description":"Whether the vendor is installed.\n\n* `1` — Installed.\n* `0` — **Not** installed.","enum":[1,0],"example":1,"type":"integer"},"installed_from":{"description":"The vendor's metadata file URL.","example":"https://www.example.com/vendor1rules/meta_vendor1.yaml","format":"url","type":"string"},"name":{"description":"The vendor's name.","example":"Vendor1 ModSecurity Core Rule Set","type":"string"},"path":{"description":"The absolute path to the directory that contains the vendor's configuration files.","example":"/usr/local/apache/conf/modsec_vendor_configs/vendor1","type":"string"},"report_url":{"description":"The URL to which the system will send reports.","example":"https://waf.example.com/api/cpanel_feedback?source=1&rule_set=1.229","format":"url","type":"string"},"supported_versions":{"description":"A list of the ModSecurity versions that the vendor supports.","example":["2.9.1","2.9.2","2.9.3"],"items":{"type":"string"},"type":"array"},"vendor_id":{"description":"The vendor's unique short name.","example":"vendor1","type":"string"},"vendor_url":{"description":"The vendor's website URL.","example":"http://www.example.com","format":"url","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_preview_vendor","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return ModSecurity vendor rule metadata","tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_preview_vendor \\\n url='https://www.example.com/vendor1rules/meta_vendor1.yaml'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_preview_vendor?api.version=1&url=https%3a%2f%2fwww.example.com%2fvendor1rules%2fmeta_vendor1.yaml"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/modsec_remove_rule":{"get":{"description":"This function removes a rule from a ModSecurity™ configuration file.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system disables this function.","operationId":"modsec_remove_rule","parameters":[{"description":"The ModSecurity configuration file's path and filename, relative to the `/usr/local/apache/conf/` directory.","in":"query","name":"config","required":true,"schema":{"example":"modsec_vendor_configs/example.conf","type":"string"}},{"description":"The rule's ID.","in":"query","name":"id","required":true,"schema":{"example":1234567890,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_remove_rule","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove ModSecurity rule","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_remove_rule \\\n config='modsec_vendor_configs/example.conf' \\\n id='1234567890'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_remove_rule?api.version=1&config=modsec_vendor_configs%2fexample.conf&id=1234567890"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_remove_setting":{"get":{"description":"This function removes a global ModSecurity™ configuration directive.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system disables this function.","operationId":"modsec_remove_setting","parameters":[{"description":"The setting's ID. For a list of available settings and their IDs, call the `modsec_get_settings` function.","in":"query","name":"setting_id","required":true,"schema":{"example":3,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_remove_setting","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove ModSecurity configuration","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_remove_setting \\\n setting_id='3'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_remove_setting?api.version=1&setting_id=3"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_remove_vendor":{"get":{"description":"This function removes a ModSecurity™ vendor. When you call this function, the system\nremoves the vendor's includes, disablement directives, configuration files, and\nmetadata file.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_remove_vendor","parameters":[{"description":"The ModSecurity vendor's unique short name.","in":"query","name":"vendor_id","required":true,"schema":{"example":"SomeVendor","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_remove_vendor","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove ModSecurity vendor","tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_remove_vendor \\\n vendor_id='SomeVendor'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_remove_vendor?api.version=1&vendor_id=SomeVendor"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/modsec_report_rule":{"get":{"description":"This function submits ModSecurity™ rule error reports to a remote receiver. The third\nparty rule vendors use these error reports to identify problems with their rule sets.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_report_rule","parameters":[{"description":"The MySQL® row IDs from the `hits` table in the `modsec` database\nfor the audit log event to report.\n\n**Note:**\n\nIf you specify more than one row ID:\n\n* You **must** comma-separate the rule IDs.\n* The rule IDs **must** all correspond to the same ModSecurity rule.","examples":{"multiple":{"summary":"Report multiple row IDs.","value":"794828, 794829, 794820"},"single":{"summary":"Report a single row ID.","value":794828}},"explode":false,"in":"query","name":"row_ids","required":true,"schema":{"type":"integer"},"style":"form"},{"description":"A short message that explains the reason for the report.","in":"query","name":"message","required":true,"schema":{"example":"Hi. We're having some trouble with this rule. It seems to be\nblocking all requests.","type":"string"}},{"description":"The contact email address to send with the error report. This allows the rule's vendor to reply to the user directly.","in":"query","name":"email","required":true,"schema":{"example":"john.doe@example.com","format":"email","type":"string"}},{"description":"The report's type.\n\n**Note:**\n\nThis value does **not** use a specified format. Treat the value as freeform text.","in":"query","name":"type","required":true,"schema":{"example":"false positive","type":"string"}},{"description":"Whether the function sends the report to the rule's vendor.\n\n* `1` — Send the report.\n* `0` — Do **not** send the report.","in":"query","name":"send","required":true,"schema":{"enum":[1,0],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"report":{"description":"An array of objects containing information for the report.","items":{"properties":{"email":{"description":"The contact email address to send with the error report. This allows the rule's vendor to reply to the report directly.","example":"john.doe@example.com","format":"email","type":"string"},"hits":{"description":"An array of objects containing information about the hit.","items":{"properties":{"action_desc":{"description":"The web server's response to the client.","example":"Access denied with code 406 (phase 2).","type":"string"},"handler":{"description":"This parameter only returns a `null` value.","example":null,"nullable":true,"type":"string"},"host":{"description":"The virtual host's (vhost) domain name.","example":"example.com","format":"domain","type":"string"},"http_method":{"description":"The\n[HTTP method](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)\nthat the client used to generate the hit.","example":"GET","type":"string"},"http_status":{"description":"The\n[HTTP status code](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html)\nthat the web server returned.","example":406,"type":"integer"},"http_version":{"description":"The HTTP version number.","example":"HTTP/1.1","type":"string"},"id":{"description":"The `modsec` database line number.","example":794828,"minimum":1,"type":"integer"},"ip":{"description":"The client's IP address.","example":"10.215.215.236","format":"ipv4","type":"string"},"justification":{"description":"The specific criteria from the ModSecurity rule that generated the hit.","example":"Unconditional match in SecAction.","type":"string"},"meta_file":{"description":"The ModSecurity configuration file that contains the rule that triggered the log entry.","example":"/usr/local/apache/conf/modsec_vendor_configs/MyVendor/one.conf","type":"string"},"meta_id":{"description":"The ID of the ModSecurity rule that triggered the log entry.","example":12345694,"type":"integer"},"meta_line":{"description":"The line number of the ModSecurity rule that triggered the log entry.","example":1,"minimum":1,"type":"integer"},"meta_logdata":{"description":"The transaction data fragment from the ModSecurity rule's `logdata` action.","example":null,"nullable":true,"type":"string"},"meta_msg":{"description":"The human-readable message from the ModSecurity rule's `msg` action.","example":"Method is not allowed by policy","nullable":true,"type":"string"},"meta_offset":{"description":"The byte offset at which a match occurred within the target\ndata.\n\n**Note:**\n\nThis data is not always available.","example":0,"minimum":0,"type":"integer"},"meta_rev":{"description":"The revision number from the ModSecurity rule's `rev` action.","example":1,"minimum":1,"nullable":true,"type":"integer"},"meta_severity":{"description":"The hit severity level from the ModSecurity\nrule's `severity` action.\n\n* `ALERT`\n* `CRITICAL`\n* `DEBUG`\n* `EMERGENCY`\n* `ERROR`\n* `INFO`\n* `NOTICE`\n* `WARNING`","enum":["ALERT","CRITICAL","DEBUG","EMERGENCY","ERROR","INFO","NOTICE","WARNING"],"example":"CRITICAL","nullable":true,"type":"string"},"meta_uri":{"description":"The client-requested URI.\n\n**Note:**\n\nThis data is not always available.","example":null,"format":"uri","nullable":true,"type":"string"},"path":{"description":"The accessed file's path, relative to the document root.","example":"/something","type":"string"},"timestamp":{"description":"The date and time at which the log entry was made.\n\n**Note:**\n\nThis parameter uses the server's configured time zone.","example":"2019-10-13T07:58:04","format":"ISO-8601 Date Time (Space Separated)","type":"string"},"timezone":{"description":"The server's configured timezone, in minutes difference from UTC/GMT.","example":"-300","type":"string"}},"type":"object"},"type":"array"},"message":{"description":"A short message that explains the reason for the report.","example":"Hi. We're having some trouble with this rule. It seems to be blocking all requests.","type":"string"},"rule_text":{"description":"The rule text from the configuration file.","example":"SecAction \"deny,auditlog,id:'12345694'\"\n","type":"string"},"type":{"description":"The report's type.\n\n**Note:**\n\nThis value does **not** use a specified format. Treat the value as\nfreeform text.","example":"false positive","type":"string"}},"type":"object"}}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_report_rule","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Export ModSecurity rule error report","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_report_rule \\\n row_ids='794828' \\\n message=$'Hi. We\\'re having some trouble with this rule. It seems to be\nblocking all requests.' \\\n email='john.doe@example.com' \\\n type='false positive' \\\n send='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_report_rule?api.version=1&row_ids=794828&message=Hi.%20We%27re%20having%20some%20trouble%20with%20this%20rule.%20It%20seems%20to%20be%0ablocking%20all%20requests.&email=john.doe%40example.com&type=false%20positive&send=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/modsec_set_config_text":{"get":{"description":"This function sets the contents of a specified ModSecurity™ configuration file. The system\nstages any changes to the configuration file. To deploy the changes, call WHM API 1's\n`modsec_deploy_rule_changes` function.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system disables this function.","operationId":"modsec_set_config_text","parameters":[{"description":"The configuration file name.","in":"query","name":"config","required":true,"schema":{"example":"modsec2.example.conf","type":"string"}},{"description":"The configuration text.","in":"query","name":"text","required":true,"schema":{"example":"SecRule REQUEST_URI \"example\" \"deny,id:123456789\" SecAction \"pass,auditlog,id\"","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_set_config_text","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update ModSecurity configuration file","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_set_config_text \\\n config='modsec2.example.conf' \\\n text='SecRule REQUEST_URI \"example\" \"deny,id:123456789\" SecAction \"pass,auditlog,id\"'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_set_config_text?api.version=1&config=modsec2.example.conf&text=SecRule%20REQUEST_URI%20%22example%22%20%22deny%2cid%3a123456789%22%20SecAction%20%22pass%2cauditlog%2cid%22"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_undisable_rule":{"get":{"description":"This function enables a ModSecurity™ rule.\n\n**Important:**\n\n When you disable the Web Server role, the system disables this function.","operationId":"modsec_undisable_rule","parameters":[{"description":"The ModSecurity configuration file.","in":"query","name":"config","required":true,"schema":{"example":"modsec_vendor_configs/example.conf","type":"string"}},{"description":"The ModSecurity rule's ID.","in":"query","name":"id","required":true,"schema":{"example":"1234567890","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_undisable_rule","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable ModSecurity rule","tags":["ModSecurity","Rule Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_undisable_rule \\\n config='modsec_vendor_configs/example.conf' \\\n id='1234567890'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_undisable_rule?api.version=1&config=modsec_vendor_configs%2fexample.conf&id=1234567890"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_set_setting":{"get":{"description":"This function sets a global ModSecurity™ configuration directive.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"modsec_set_setting","parameters":[{"description":"The setting's ID.\n\n**Note:**\n\n The WHM API 1 `modsec_get_settings` function returns this value.","in":"query","name":"setting_id","required":true,"schema":{"example":8,"minimum":0,"type":"integer"}},{"description":"The setting's new state. The function uses this as a valid argument\nfor the directive.\n\n**Note:**\n\n For more information, read SpiderLabs' [ModSecurity documentation](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual).","in":"query","name":"state","required":true,"schema":{"example":"2000","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"default":{"description":"The setting's default value.","example":"1500","type":"string"},"description":{"description":"The setting's description.","example":"This setting allows you to define the match limit of the PCRE library.","type":"string"},"directive":{"description":"The setting's Apache® directive.","example":"SecPcreMatchLimit","type":"string"},"name":{"description":"The setting's name.","example":"PCRE library match limit","type":"string"},"radio_options":{"description":"An array of objects with the options that the client should display, as buttons, for this setting in a user interface.\n\n**Note:**\n\n The function **only** returns this array of objects when you set the `type` parameter's value to `radio`.","items":{"properties":{"name":{"description":"The setting name to display to the user. The user's [locale](https://go.cpanel.net/localedocs) may translate this value.","example":"Log all transactions.","type":"string"},"option":{"description":"The setting that the system used to select the setting's state.\n\n**Note:**\n\n This value is identical to the string that the client sends in as `state` value when users select the specified setting. In most cases, you should **not** display this value to the user. Instead, display the `name` value.","example":"On","type":"string"}},"type":"object"},"type":"array"},"setting_id":{"description":"The setting's ID.","example":8,"minimum":0,"type":"integer"},"state":{"description":"The setting's new state.","example":2000,"type":"integer"},"type":{"description":"The type of UI control that the client should use to represent the setting.\n\n* `text` - WHM users modify this setting via a text box.\n* `radio` - WHM users modify this setting via a radio button.\n - **Note:** If the `type` parameter's value is `radio`, the function also returns the `radio_options` array of objects.\n* `number` - WHM users modify this setting via a text box that only allows numeric values.","enum":["text","radio","number"],"example":"text","type":"string"},"url":{"description":"The URL for the setting's documentation.","example":"https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secpcrematchlimit","format":"url","type":"string"},"validation":{"description":"A validator or array of validators to apply. Use these validators to perform frontend validation through your preferred implementation methods.\n\n**Note:**\n\n The function may represent each validator as either a string or an object.\n * When the function represents the validator as a string, no arguments exist for the validator.\n * When the function returns the validator as a object, the API may also include an argument for the validator.","items":{"anyOf":[{"description":"A JSON object string that contains one or more arguments for the validator.","properties":{"arg":{"description":"The regular expression pattern that is used with `name` when the validator checks a user's input.","example":"[Ee]xample"},"name":{"description":"The method that determines where the validator should match a pattern in a user's input.","example":"startsWith"}},"type":"object"},{"description":"A string that is one of the following values:\n * `path` - An instruction to verify whether the user's input is a valid path.\n * `honeypotAccessKey` - An instruction to verify whether the user's input fits the constraints of an `Http:BL` API access key.\n * `positiveInteger` - An instruction to verify whether the user's input is a positive integer.","enum":["path","honeypotAccessKey","positiveInteger"],"example":"positiveInteger","type":"string"}]},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_set_setting","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update ModSecurity configuration","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_set_setting \\\n setting_id='8' \\\n state='2000'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_set_setting?api.version=1&setting_id=8&state=2000"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.46"}},"/modsec_update_vendor":{"get":{"description":"This function updates a vendor with the current version of the rule set.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system disables this function.","operationId":"modsec_update_vendor","parameters":[{"description":"The vendor metadata file's URL.","in":"query","name":"url","required":true,"schema":{"example":"http://example.com/update/meta_MyVendor.yaml","format":"url","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"diagnostics":{"description":"A list of diagnostic information about the update.","properties":{"added_configs":{"description":"A list of the ModSecurity configuration files that the update added.","items":{"example":"modsec_vendor_configs/MyVendor/three.conf","type":"string"},"type":"array"},"deleted_configs":{"description":"An array of objects containing the ModSecurity configuration files that the update removed.","items":{"example":"modsec_vendor_configs/MyVendor/one.conf","type":"string"},"type":"array"},"new_configs":{"description":"A complete list of configuration files that the update modified.","items":{"properties":{"active":{"description":"Whether the configuration file is active.\n\n* `1` — Active.\n* `0` — **Not** active.","enum":[1,0],"example":0,"type":"integer"},"config":{"description":"The file path to the configuration file, relative to the `/usr/local/apache/conf/` Apache configuration directory.","example":"modsec_vendor_configs/MyVendor/two.conf","type":"string"},"vendor_id":{"description":"The vendor's unique name.","example":"MyVendor","type":"string"}},"type":"object"},"type":"array"},"prev_configs":{"description":"A list of configuration files in the old version.","items":{"properties":{"config":{"description":"The file path of the configuration file, relative to the `/usr/local/apache/conf/` Apache configuration directory.","example":"modsec_vendor_configs/MyVendor/two.conf","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"vendor":{"description":"A list of updated vendor information.","properties":{"archive_url":{"description":"The URL to download the vendor rules.","example":"http://example.com/update/MyVendor.zip","format":"url","type":"string"},"cpanel_provided":{"description":"Whether WebPros International, LLC provided the rule set.\n\n* `1` — Provided by WebPros International, LLC.\n* `0` — Not provided WebPros International, LLC.","enum":[1,0],"example":0,"type":"integer"},"description":{"description":"The vendor's description.","example":"This is an example of a custom vendor set (updated).","type":"string"},"dist_md5":{"description":"The download's [MD5](https://en.wikipedia.org/wiki/MD5) checksum value.","example":"ecafce1bf148532250a8d4743a8374d1","type":"string"},"enabled":{"description":"Whether the vendor is enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[1,0],"example":1,"type":"integer"},"inst_dist":{"description":"The unique identifier for the rule set version.","example":"MyVendor-2","type":"string"},"installed":{"description":"Whether the vendor is installed.\n\n* `1` — Installed.\n* `0` — **Not** installed.","enum":[1,0],"example":1,"type":"integer"},"installed_from":{"description":"The URL to the vendor's metadata file.","example":"http://example.com/update/meta_MyVendor.yaml","format":"url","type":"string"},"name":{"description":"The vendor's name.","example":"My Vendor","type":"string"},"path":{"description":"The file path to the vendor's ModSecurity configuration files.","example":"/usr/local/apache/conf/modsec_vendor_configs/MyVendor","type":"string"},"report_url":{"description":"The URL that the vendor uses to receive problem reports.","example":"http://example.com/report/","format":"url","type":"string"},"vendor_id":{"description":"The vendor's unique short name.","example":"MyVendor","type":"string"},"vendor_url":{"description":"The URL to the vendor's website.","example":"http://example.com/","format":"url","type":"string"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_update_vendor","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update ModSecurity vendor ruleset","tags":["ModSecurity","Rule Vendor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_update_vendor \\\n url='http://example.com/update/meta_MyVendor.yaml'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_update_vendor?api.version=1&url=http%3a%2f%2fexample.com%2fupdate%2fmeta_MyVendor.yaml"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/background_mysql_upgrade_checker_run":{"get":{"description":"This function checks your MySQL configuration file and table engine before an upgrade to MySQL 8.0.\n\n**Important:**\n\nWhen you disable the\n[MySQL/MariaDB role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles)\n**and** remote MySQL is **not** already configured, the system **disables** this function.","operationId":"background_mysql_upgrade_checker_run","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"log_entry":{"description":"The upgrade log's location, relative to the\n[`/var/cpanel/logs/`](https://docs.cpanel.net/knowledge-base/cpanel-product/the-cpanel-log-files/#/var-cpanel-logs)\ndirectory.","example":"mysql_upgrade.20200202-172923","type":"string"},"pid":{"description":"The upgrade check's process ID.","example":23456,"minimum":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"background_mysql_upgrade_checker_run","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate MySQL status before upgrade","tags":["Databases","Manage MySQL Server"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n background_mysql_upgrade_checker_run\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/background_mysql_upgrade_checker_run?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"88"}},"/current_mysql_version":{"get":{"description":"This function retrieves the server's version of MySQL® or MariaDB®.\n\n**Important:**\n\n When you disable the [MySQL/MariaDB role](https://go.cpanel.net/serverroles) **and** remote MySQL is **not** already configured, the system **disables** this function.","operationId":"current_mysql_version","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"server":{"default":"mysql","description":"The server's database engine.\n* `mysql`\n* `mariadb`","enum":["mysql","mariadb"],"example":"mysql","type":"string"},"version":{"description":"The version number, in `major`.`minor` format.","example":"8.0","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"current_mysql_version","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return MySQL version","tags":["Databases","Manage MySQL Server"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n current_mysql_version\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/current_mysql_version?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"cPanel 11.48"}},"/background_mysql_upgrade_status":{"get":{"description":"This function retrieves the status of a background MySQL® or MariaDB® upgrade.\n\n**Important:**\n\n When you disable the [MySQL/MariaDB](https://go.cpanel.net/serverroles) role and remote MySQL is **not** already configured, the system **disables** this function.","operationId":"background_mysql_upgrade_status","parameters":[{"description":"The logfile's name.\n\n**Note:**\n\n Log files exist in the `/var/cpanel/logs/` directory.","in":"query","name":"upgrade_id","required":true,"schema":{"example":"mysql_upgrade.20141108-172923","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"error":{"description":"An error code.\n* `0` — Successful upgrade.\n* `-1` — Child process died from a signal.\n* `4` — MySQL upgrade failed error code.","example":0,"type":"integer"},"error_log":{"description":"The upgrade's error log file.\n\n**Note:**\n\n You can review MySQL upgrade error logs in the following location, where $TIME represents the time in [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time) format: `/var/cpanel/logs/mysql_upgrade.$TIME/unattended_background_upgrade.error`.","example":"Starting The system failed to update MYSQL,\\n------------------------------------\\n","type":"string"},"log":{"description":"The upgrade's log file.","example":"Starting process with log file at /var/cpanel/logs/mysql_upgrade.20141108-172923/unattended_background_upgrade.log\nBeginning MariaDB 10.0 upgrade...\nObtained version information from system.\nEnsuring the MariaDB100 repository is available and working.\ncheckyum version 22.3\nEnsuring that the package MariaDB-client with version matching 10.0 is available.\nEnsuring that the package MariaDB-common with version matching 10.0 is available.\nEnsuring that the package MariaDB-devel with version matching 10.0 is available.\nEnsuring that the package MariaDB-server with version matching 10.0 is available.\nEnsuring that the package MariaDB-shared with version matching 10.0 is available.\nEnsuring that the package coreutils is available.\nEnsuring that the package grep is available.\nEnsuring that the package perl-DBI is available.\n your MariaDB server version for the right syntax to use near ''.`netcopya0I5KfqYTfHqJr` FOR UPGRADE'' at line 1 when executing ''CHECK TABLE ... FOR UPGRADE''\nFATAL ERROR: Upgrade failed\nDone building configuration.\nHooks system enabled.\nChecking for and running RPM::Versions ''post'' hooks for any RPMs about to be installed\nAll required ''post'' hooks have been run\nRunning: /usr/local/cpanel/scripts/check_cpanel_pkgs --targets=MySQL41,MySQL50,MySQL51,MySQL55,MySQL56,MariaDB100,MariaDB101 --fix\nRestarting mysql service.\nWaiting for mysql to restart waiting for mysql to initialize finished.\n\u001b[1;32mMariaDB upgrade completed successfully\u001b[0m\n------------------------------------\n","type":"string"},"state":{"description":"The upgrade's state.\n* success\n* failed\n* in progress","enum":["success","failed","in progress"],"example":"success","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"background_mysql_upgrade_status","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return MySQL or MariaDB upgrade status","tags":["Databases","Manage MySQL Server"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n background_mysql_upgrade_status \\\n upgrade_id='mysql_upgrade.20141108-172923'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/background_mysql_upgrade_status?api.version=1&upgrade_id=mysql_upgrade.20141108-172923"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"cPanel 11.48"}},"/installable_mysql_versions":{"get":{"description":"This function lists all available versions of MySQL® and MariaDB.\n\n**Important:**\n\nWhen you disable the [MySQL/MariaDB](https://go.cpanel.net/howtouseserverprofiles#roles) role **and** remote MySQL is **not** already configured, the system disables this function.","operationId":"installable_mysql_versions","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"versions":{"description":"An array of objects that contain information about the database version information.","items":{"properties":{"server":{"description":"The server's database engine.\n* `mysql`\n* `mariadb`","enum":["mysql","mariadb"],"example":"mariadb","type":"string"},"version":{"description":"The version number in `major.minor` format.","example":"10.0","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"installable_mysql_versions","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return available MySQL versions","tags":["Databases","Manage MySQL Server"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n installable_mysql_versions\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/installable_mysql_versions?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"cPanel 11.48"}},"/set_service_proxy_backends":{"get":{"description":"This function lets you configure a cPanel account's\n[service proxying](https://go.cpanel.net/ServiceProxying).\n\n**Note:**\n\n* If the cPanel account is a [distributed account](https://go.cpanel.net/cPanelGlossary#distributed-cpanel-account),\nand you call this function on the account’s [parent node](https://go.cpanel.net/cPanelGlossary#parent-node),\nthe system will propagate the new service proxying to the [child node](https://go.cpanel.net/cPanelGlossary#child-node).\n* If the [Web Server](https://go.cpanel.net/howtouseserverprofiles#roles) role is active\non the server, this function rebuilds the user's web virtual hosts (vhosts) and restarts\nthe web server.\n* If the system cannot rebuild the user's vhosts, the API call will still succeed. However,\nthe function returns a failure warning in the metadata.\n* To remove an account's service proxying, use the WHM API 1 `unset_all_service_proxy_backends`\nfunction.","operationId":"set_service_proxy_backends","parameters":[{"description":"The cPanel account's username.","in":"query","name":"username","required":true,"schema":{"example":"example","format":"username","type":"string"}},{"description":"The hostname or IP address to assign as the server that handles\nthe account's service proxy requests.\n\nThis parameter defaults to the existing service proxy configuration,\nif one exists.","in":"query","name":"general","required":false,"schema":{"anyOf":[{"description":"A valid hostname.","example":"hostname.example.com","format":"hostname","type":"string"},{"description":"A valid IP address.","example":"192.0.2.102","format":"ipv4","type":"string"}]}},{"description":"The name of a service group for which to assign a proxy backend. The\ncorresponding `service_group_backend` value will be the service group's\nnew proxy backend.\n\n* `Mail` — The [Mail service group](https://go.cpanel.net/ServiceProxying#Mail).\n\nThis parameter defaults to the existing setting, if one exists.\n\n**Note:**\n\n * When you call this parameter, you **must** include a corresponding\n `service_group_backend` value.\n * To add `multiple service_group` values, increment the parameter name. For example,\n `service_group-1`, `service_group-2`, and `service_group-3`.","examples":{"multiple":{"summary":"Add multiple service backend groups.","value":"service-group-0=Mail&service-group-1=Mail&service-group-3=Mail"},"single":{"summary":"Add a single service backend group.","value":"Mail"}},"in":"query","name":"service_group","required":false,"schema":{"enum":["Mail"],"type":"string"}},{"description":"The hostname or IP address of the server to assign as the corresponding\n`service_group` value's proxy backend server.\n\nThis parameter defaults to the existing setting, if one exists.\n\n**Note:**\n\n * When you call this parameter, you **must** include a corresponding `service_group`\n value.\n * To add multiple `service_group_backend` values, increment the parameter name.\n For example, `service_group_backend-1`, `service_group_backend-2`,\n and `service_group_backend-3`.","examples":{"multiple":{"summary":"Add multiple service group backend servers.","value":"service_group_backend-1=mail.example1.com&service_group_backend-2=mail.example2.com&service_group_backend-3=mail.example3.com"},"single":{"summary":"Add a single service group backend server.","value":"mail.example.com"}},"in":"query","name":"service_group_backend","required":false,"schema":{"anyOf":[{"description":"A valid hostname.","example":"hostname.example.com","format":"hostname","type":"string"},{"description":"A valid IP address.","example":"192.0.2.102","format":"ipv4","type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_service_proxy_backends","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update cPanel account service proxying","tags":["Services"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_service_proxy_backends \\\n username='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_service_proxy_backends?api.version=1&username=example"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"90"}},"/nat_checkip":{"get":{"description":"This function validates a public IP address on a NAT-configured server.","operationId":"nat_checkip","parameters":[{"description":"The local IPv4 address.","in":"query","name":"ip","required":true,"schema":{"example":"192.168.4.10","format":"ipv4","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"checked_ip":{"description":"The local IPv4 address.","example":"192.168.4.10","format":"ipv4","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"nat_checkip","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate public IP address for NAT","tags":["IP Addresses","Network Address Translation"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n nat_checkip \\\n ip='192.168.4.10'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/nat_checkip?api.version=1&ip=192.168.4.10"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.40"}},"/nat_set_public_ip":{"get":{"description":"This function pairs a local IP address with a public IP address on NAT-configured servers.","operationId":"nat_set_public_ip","parameters":[{"description":"The local IPv4 address.","in":"query","name":"local_ip","required":true,"schema":{"example":"192.168.4.10","format":"ipv4","type":"string"}},{"description":"The public IPv4 address.","in":"query","name":"public_ip","required":true,"schema":{"example":"10.5.3.33","format":"ipv4","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"nat_set_public_ip","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Register NAT IP address to public IP address","tags":["IP Addresses","Network Address Translation"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n nat_set_public_ip \\\n local_ip='192.168.4.10' \\\n public_ip='10.5.3.33'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/nat_set_public_ip?api.version=1&local_ip=192.168.4.10&public_ip=10.5.3.33"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.40"}},"/latest_available_mysql_version":{"get":{"description":"This function retrieves the latest available version of MySQL® or MariaDB®.\n\n**Important:**\n\nWhen you disable the [MySQL/MariaDB role](https://go.cpanel.net/serverroles) and remote MySQL is **not** already configured, the system **disables** this function.","operationId":"latest_available_mysql_version","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"server":{"description":"The server's database engine.\n* `mysql`\n* `mariadb`","enum":["mysql","mariadb"],"example":"mariadb","type":"string"},"version":{"description":"The version number in `major.minor` format.","example":"10.0","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"latest_available_mysql_version","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return latest MySQL version","tags":["Databases","Manage MySQL Server"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n latest_available_mysql_version\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/latest_available_mysql_version?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"cPanel 11.48"}},"/verify_new_username":{"get":{"description":"This function checks for username conflicts during account creation.","operationId":"verify_new_username","parameters":[{"description":"The account that you wish to create.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"verify_new_username","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result`\nfield is `0`. This field may display a success message when\na function succeeds.\n\n**Note:**\n\nIf the function detects a username conflict, it returns an error\nmessage in this field.","example":"OK","type":"string"},"result":{"description":"- `1` — Success.\n- `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate new cPanel account username","tags":["Account Creation"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n verify_new_username \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/verify_new_username?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/get_nameserver_config":{"get":{"description":"This function retrieves the default nameservers for the currently-authenticated user.","operationId":"get_nameserver_config","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"nameservers":{"description":"The currently-authenticated user's nameservers.","example":["ns1.example.com","ns2.example.com"],"items":{"type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_nameserver_config","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return current user's nameservers","tags":["DNS","Resolvers"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_nameserver_config\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_nameserver_config?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/lookupnsip":{"get":{"description":"This function retrieves a nameserver's IP address.","operationId":"lookupnsip","parameters":[{"description":"The nameserver's hostname.","in":"query","name":"host","required":true,"schema":{"example":"ns1.example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"ip":{"description":"The nameserver's IP address.","example":"192.168.0.20","format":"ipv4","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"lookupnsip","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return nameserver's IP address","tags":["DNS","Resolvers"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n lookupnsip \\\n host='ns1.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/lookupnsip?api.version=1&host=ns1.example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/verify_new_username_for_restore":{"get":{"description":"This function checks for username conflicts during account restoration. If the function detects a username conflict, it outputs an error message in the `reason` return.","operationId":"verify_new_username_for_restore","parameters":[{"description":"The cPanel account that you wish to transfer to the server.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"verify_new_username_for_restore","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"- `1` — Success.\n- `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate username during restoration","tags":["Account Restoration","Restore Account"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n verify_new_username_for_restore \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/verify_new_username_for_restore?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/modsec_deploy_settings_changes":{"get":{"description":"This function deploys the staged changes to your `modsec2.cpanel.conf` file and\nattempts to restart Apache. If the new settings fail validation, the system restores\nthe `/etc/apache2/conf.d/modsec/modsec2.cpanel.conf` file.\n\n**Note:**\n\nCall the WHM API 1 `modsec_set_setting` function to prepare your changes for\nthe `modsec2.cpanel.conf` file.\n\n**Important:**\n\nWhen you disable the\n[Web Server role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"modsec_deploy_settings_changes","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"modsec_deploy_settings_changes","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable staged ModSecurity configuration files","tags":["ModSecurity","Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n modsec_deploy_settings_changes\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/modsec_deploy_settings_changes?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.48"}},"/resolvedomainname":{"get":{"description":"This function resolves a domain's IPv4 address.","operationId":"resolvedomainname","parameters":[{"description":"The domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"ip":{"description":"The domain's IPv4 address.","example":"192.168.0.20","format":"ipv4","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"resolvedomainname","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domain's IP address","tags":["DNS","Domain Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n resolvedomainname \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/resolvedomainname?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.28"}},"/lookupnsips":{"get":{"description":"This function retrieves a nameserver's IPv4 and IPv6 addresses.","operationId":"lookupnsips","parameters":[{"description":"The nameserver's hostname.","in":"query","name":"host","required":true,"schema":{"example":"ns1.example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"ipv4":{"description":"The nameserver's IPv4 address.\n\n**Note:**\n\n The function returns this value **only** if a nameserver with an IPv4 address exists on the server.","example":"192.0.2.0","format":"ipv4","type":"string"},"ipv6":{"description":"The nameserver's IPv6 address.\n\n**Note:**\n\n The function returns this value **only** if a nameserver with an IPv6 address exists on the server.","example":"2001:0db8:0:0:1:0:0:1","format":"ipv6","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"lookupnsips","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return nameserver's IPv4 and IPv6 addresses","tags":["DNS","Resolvers"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n lookupnsips \\\n host='ns1.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/lookupnsips?api.version=1&host=ns1.example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"60"}},"/set_nameserver":{"get":{"description":"This function sets the nameserver software that the remote servers in a DNS cluster run. The system queues the nameserver software that you select until the HTTP request finishes. Then, it sets the remote servers' nameserver software.","operationId":"set_nameserver","parameters":[{"description":"The nameserver software.\n* `BIND`\n* `PowerDNS`\n* `Disabled`","in":"query","name":"nameserver","required":true,"schema":{"enum":["BIND","PowerDNS","Disabled"],"example":"BIND","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"message":{"description":"A confirmation message from the system.","example":"Queued task to set nameserver to bind successfully.","type":"string"},"nameserver":{"description":"The nameserver software.\n* `bind`\n* `powerdns`\n* `disabled`","enum":["bind","powerdns","disabled"],"example":"bind","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_nameserver","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update remote DNS server's nameserver software","tags":["DNS","DNS Cluster Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_nameserver \\\n nameserver='BIND'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_nameserver?api.version=1&nameserver=BIND"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"84"}},"/backup_get_transport_status":{"get":{"description":"This function retrieves the status of any backup transport events on the account.","operationId":"backup_get_transport_status","parameters":[{"description":"The transport's identification (ID). If you do **not** specify this parameter,\nthe function returns **all** transports on the account.\n\n**Note:**\n\nYou can use this parameter or the `transport_name` parameter.","in":"query","name":"transport_id","required":false,"schema":{"example":"transportname","type":"string"}},{"description":"That transport's current state. If you do **not** specify this parameter,\nthe function returns the status of **all** transports on the account.\n\n* `completed`\n* `failed`\n* `pending`\n* `running`","in":"query","name":"state","required":false,"schema":{"enum":["completed","failed","pending","running"],"example":"running","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"pages":{"description":"The number of pages that the backup transports contain.\n\n**Note:**\n\nThis return's value depends on the\n[pagination variables](https://go.cpanel.net/paginationvariables)\nthat you pass when you call the function.","example":3,"type":"integer"},"transport_status":{"description":"A list of information about each transport event.","items":{"properties":{"date":{"description":"The backup transport event's date.","example":"2019-08-30T00:00:00.000Z","format":"ISO-8601 Date","type":"string"},"end_timestamp":{"description":"The transport event's end time, in `YYYY-MM-DD HH:MM:SS` format.","example":"2019-08-30T02:04:06.000Z","type":"string"},"start_timestamp":{"description":"The transport event's start time, in `YYYY-MM-DD HH:MM:SS` format.","example":"2019-08-30T02:04:08.000Z","type":"string"},"status":{"description":"The transport event's status.\n\n* `completed`\n* `failed`\n* `pending`\n* `running`","example":"running","type":"string"},"transport":{"description":"The transport event's name.\n\n**Note:**\n\nIf multiple transports use the same name, the system returns the first\ninstance of the transport with that name.","example":"transportname","type":"string"},"user":{"description":"The user for whom the system transported the backup.","example":"username","type":"string"}}},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"backup_get_transport_status","type":"string"},"reason":{"description":"The reason the function failed when the `metadata.result` field is `0`. This field may include a success message when the function succeeds.","example":"OK","type":"string"},"result":{"description":"- `1` — Success.\n- `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The API version of the function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return backup transport events' status","tags":["Backups","Backup or Restore"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n backup_get_transport_status\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/backup_get_transport_status?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"78"}},"/batch":{"get":{"description":"This function combines calls for multiple WHM API 1 functions.","operationId":"batch","parameters":[{"description":"The WHM API 1 function to call.\n\n**Important:**\n\nSpecify a `command` parameter for each function.\n\n**Note:**\n\nInclude the function's input parameters as a URI-encoded list after the function name.\nFor example, to call the `killdns` function with a `domain` parameter value of `example.com`\ndirectly you would use:\n\n `killdns?domain=example.com`\n\nTo call this function using the `batch` function, URI-encode the command and pass it as part of the `batch` function:\n\n `/json-api/batch?api.version=1&command=killdns%3Fdomain%3Dexample.com`\n\nYou can call the same function multiple times within a single batch API call. For example:\n\n `/json-api/batch?api.version=1&command=version&command=version&command=version`","in":"query","name":"command","required":true,"schema":{"example":"version","type":"string"}},{"description":"Whether to stop processing remaining commands in the batch when a command returns an error.\n\n* `1` — Do **not** process remaining commands in the batch when an error occurs.\n* `0` — When an error occurs, process the remaining commands in the batch.","in":"query","name":"abort_on_error","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"result":{"description":"Information regarding function output. Each result contains the returns from one of the command parameter's functions. For information about each function's returns, read the function's documentation.","example":[{"data":{"hostname":"example-hosting.com"},"metadata":{"command":"gethostname","reason":"OK","result":1,"version":1}},{"data":{"version":"11.88.0.1"},"metadata":{"command":"version","reason":"OK","result":1,"version":1}}],"items":{"properties":{"data":{"description":"The data returned by the command.","type":"object"},"metadata":{"description":"The metadata returned by the command.","properties":{"command":{"description":"The method name called.","example":"version","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"batch","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Run multiple WHM API 1 functions","tags":["API Execution"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n batch \\\n command='version'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/batch?api.version=1&command=version"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/emailtrack_search":{"get":{"description":"This function retrieves email delivery records.\n\n**Warning:**\n\n* On most servers, this function returns a large amount of output. We **strongly**\nrecommend that you [filter](https://go.cpanel.net/WHMAPI1FilterOutput) and\n[sort](https://go.cpanel.net/WHMAPI1SortOutput) the output.\n* The following example uses the filter and sort options:\n\n `https://hostname.example.com:2087/cpsess##########/json-api/emailtrack_search?api.version=1&api.filter.enable=1&api.filter.a.field=sendunixtime&api.filter.a.arg0=1628889719&api.filter.a.type=gt&api.filter.b.field=sendunixtime&api.filter.b.arg0=1629847321&api.filter.b.type=lt&api.sort.enable=1&api.sort.a.field=sendunixtime&api.sort.a.reverse=0&api.chunk.enable=1&api.chunk.size=25&api.chunk.start=1&success=1`","operationId":"emailtrack_search","parameters":[{"description":"Whether to return successful delivery attempts.\n* `1` — Return successful delivery attempts.\n* `0` — Do not return successful delivery attempts.","in":"query","name":"success","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to return delivery deferral events.\n* `1` — Return delivery deferral events.\n* `0` — Do not return delivery deferral events.","in":"query","name":"defer","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to return delivery failure events.\n* `1` — Return delivery failure events.\n* `0` — Do not return delivery failure events.","in":"query","name":"failure","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to return delivery attempts in progress.\n* `1` — Return delivery attempts in progress.\n* `0` — Do not return delivery attempts in progress.","in":"query","name":"inprogress","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"The type of delivery records to retrieve.\n* `all` — Retrieve all delivery records.\n* `remote` — Retrieve remote delivery records.\n* `local` — Retrieve local delivery records.","in":"query","name":"deliverytype","required":false,"schema":{"default":"all","enum":["all","remote","local"],"example":"all","type":"string"}},{"description":"The number of results to return for each type.\n\n**Note**\n\nIf you set this parameter to `0`, the function returns unlimited results.","in":"query","name":"max_results_by_type","required":false,"schema":{"default":0,"example":3,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"records":{"description":"An array of objects containing the delivery record.","items":{"properties":{"actiontime":{"description":"When the delivery attempt happened in `YYYY-MM-DD HH-mm-SS` format.","example":"2012-02-06T14:17:51","type":"string"},"actionunixtime":{"description":"When the delivery attempt happened.","example":1328559471,"format":"unix_timestamp","type":"integer"},"deliveredto":{"description":"The delivery attempt's final end point.\n\n**Note:**\n\n If the message went to a mailing list, the address will be the mailing list member's address.","example":null,"nullable":true,"type":"string"},"deliverydomain":{"description":"The recipient's domain.","example":null,"format":"domain","nullable":true,"type":"string"},"deliveryuser":{"description":"The recipient's username.","example":null,"nullable":true,"type":"string"},"domain":{"description":"The sender's domain.","example":"example.com","format":"domain","type":"string"},"host":{"description":"The hostname that received the message.","example":null,"format":"hostname","nullable":true,"type":"string"},"ip":{"description":"The recipient's IP address.","example":null,"format":"ipv4","nullable":true,"type":"string"},"message":{"description":"The action taken.","example":"Domain example.com has exceeded the max defers and failures per hour (5/5 (100%)) allowed. Message discarded.","type":"string"},"msgid":{"description":"The message ID.","example":"1RuV0Z-0005NR-BN","type":"string"},"recipient":{"description":"The recipient's mail address.","example":"user@example.com","format":"email","type":"string"},"router":{"description":"The mail server's internal router name.","example":"enforce_mail_permissions","type":"string"},"sender":{"description":"The sender's full email address.","example":"user@example.com","type":"string"},"senderauth":{"description":"The user authentication.","example":"localuser","format":"hostname","type":"string"},"senderhost":{"description":"The sender's hostname.","example":"localhost","format":"hostname","type":"string"},"senderip":{"description":"The sender's IP address.","example":"127.0.0.1","type":"string"},"sendunixtime":{"description":"When the message was sent.","example":1328559471,"format":"unix_timestamp","type":"integer"},"size":{"description":"The message's size.","example":1653,"format":"bytes","minimum":1,"type":"integer"},"spamscore":{"description":"The message's spam score.\n\n**Note:**\n\nIf the spam prevention engine uses a result range from `0` to `1` , the system multiplies the result by `10`.","example":5,"minimum":0,"type":"integer"},"transport":{"description":"The mail transfer agent (MTA).","example":null,"nullable":true,"type":"string"},"transport_is_remote":{"description":"Whether the mail transfer agent (MTA) is remote.\n* `1` — Remote.\n* `0` — Not remote.","enum":[0,1],"example":0,"type":"integer"},"type":{"description":"The delivery status.\n* `success`\n* `defer`\n* `failure`\n* `inprogress`","enum":["success","defer","failure","inprogress"],"example":"success","type":"string"},"user":{"description":"The sender's username.","example":"cpanel1","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"emailtrack_search","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email delivery records by search criteria","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n emailtrack_search\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/emailtrack_search?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/applist":{"get":{"description":"This function lists available WHM API 1 functions.","operationId":"applist","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"app":{"description":"An array of available WHM API 1 functions.","example":["accountsummary","listaccts"],"items":{"type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"applist","type":"string"},"reason":{"description":"The reason the api failed when the metadata.result field is 0. The field may be set to a success message on a successful call.","example":"OK","type":"string"},"result":{"description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the api call.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return WHM API 1 functions list","tags":["Applications"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n applist\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/applist?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/cluster_member_has_trust_with":{"get":{"description":"This function queries whether nameservers in a DNS cluster can share records with one another. Servers in a DNS cluster **must** exist in a [Reverse Trust relationship](https://go.cpanel.net/whmdocsDNSCluster) to share information. This relationship requires each server to have an [API token](https://go.cpanel.net/ManageAPITokens).\n\n**Note:**\n\n DNS servers in a Write-Only role do not need to exist in a Reverse Trust relationship. For more information, read our [Guide to DNS Cluster Configurations](https://go.cpanel.net/DNSClusterConfig) documentation.","operationId":"cluster_member_has_trust_with","parameters":[{"description":"The nameserver's IP address.","in":"query","name":"host","required":true,"schema":{"example":"192.0.2.0","format":"ipv4","type":"string"}},{"description":"The nameserver's alternate IP address. This is useful, for example, if your DNS cluster exists in a NAT-configured network.","in":"query","name":"althost","required":false,"schema":{"default":"","example":"192.0.3.0","format":"ipv4","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"has_trust":{"description":"Whether the nameserver can send information to other cluster members.\n* `1` — Can send information.\n* `0` — Can't send information.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"cluster_member_has_trust_with","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether DNS cluster server can share records","tags":["DNS","DNS Zones"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n cluster_member_has_trust_with \\\n host='192.0.2.0'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/cluster_member_has_trust_with?api.version=1&host=192.0.2.0"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"84"}},"/cpanel":{"get":{"description":"You can call cPanel API and UAPI functions through the WHM API.\n\nThis method is useful, for example, when you develop plugins for WHM users, particularly resellers, but need to access cPanel functions. You can make these calls from within either the WHM or cPanel interfaces.\n\n**Important:**\n\nWe recommend that you use the WHM API 1 `uapi_cpanel` function. The `uapi_cpanel` function is a more flexible way to call cPanel API functions from WHM. For example, you can use the `uapi_cpanel` function with the WHM API 1 `batch` function.\n\nBefore calling a cPanel API function via this method, read its documentation. The cPanel API function may require other parameters **not** listed in this document.","operationId":"cpanel","parameters":[{"description":"The cPanel username for the account through which to call the function.\n\nMake **certain** that you specify the username in lowercase characters **only**. cPanel & WHM automatically converts usernames to lowercase when you create a cPanel account. For this reason, if you supply a username that includes some or all capital letters, the call will fail.","in":"query","name":"cpanel_jsonapi_user","required":true,"schema":{"example":"user","format":"username","type":"string"}},{"description":"The UAPI module name.\n\n**Important:**\n\nModule names are **case-sensitive**.","in":"query","name":"cpanel_jsonapi_module","required":true,"schema":{"example":"Email","type":"string"}},{"description":"The UAPI function name.\n\n**Important:**\n\nFunction names are **case-sensitive**.","in":"query","name":"cpanel_jsonapi_func","required":true,"schema":{"example":"listpopswithdisk","type":"string"}},{"description":"The cPanel API version to use.\n* `1` — Use cPanel API 1.\n* `2` — Use cPanel API 2.\n* `3` — Use UAPI.","in":"query","name":"cpanel_jsonapi_apiversion","schema":{"default":2,"enum":[1,2,3],"example":3,"type":"integer"}},{"description":"The function's input parameters and their values. You can add any additional parameters supported by the underlying cPanel API function.\n\nExample: `domain=example.com`\n\n**Note:**\n* Separate multiple `parameter=value` pairs with the ampersand character (`&`).\n* You **must** URI-encode these values.","in":"query","name":"Variable Names and Values","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"description":"Information returned by the cPanel API function passed in `cpanel_jsonapi_module` and `cpanel_jsonapi_func`."},"metadata":{"properties":{"command":{"description":"The method name called.","example":"cpanel","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Run cPanel API or UAPI function","tags":["API Execution"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n cpanel \\\n cpanel_jsonapi_user='user' \\\n cpanel_jsonapi_module='Email' \\\n cpanel_jsonapi_func='listpopswithdisk'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/cpanel?api.version=1&cpanel_jsonapi_user=user&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=listpopswithdisk"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"84"}},"/emailtrack_user_stats":{"get":{"description":"This function retrieves email tracking statistics for each user.","operationId":"emailtrack_user_stats","parameters":[{"description":"The start time of the search window.","in":"query","name":"starttime","required":false,"schema":{"default":0,"example":1371552781,"format":"unix_timestamp","type":"integer"}},{"description":"The end time of the search window.","in":"query","name":"endtime","required":false,"schema":{"default":"the current time","example":1471552781,"format":"unix_timestamp","type":"integer"}},{"description":"The type of delivery to query. If you do not specify a value,\nthis function returns all types.\n* `remote`\n* `remote-or-faildefer`\n* `local`","in":"query","name":"deliverytype","required":false,"schema":{"enum":["remote","remote-or-faildefer","local"],"example":"remote","type":"string"}},{"description":"The sender's email address. If you do not specify a value, this function returns entries for mail from all senders.","in":"query","name":"sender","required":false,"schema":{"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"records":{"description":"An array of objects containing the message information.","items":{"properties":{"DEFERCOUNT":{"description":"The number of deferral events.","example":0,"minimum":0,"type":"integer"},"DEFERFAILCOUNT":{"description":"The number of messages that the system deferred and failed to deliver.","example":0,"minimum":0,"type":"integer"},"DOMAIN":{"description":"The mailbox's domain.","example":"example.com","format":"domain","type":"string"},"FAILCOUNT":{"description":"The number of delivery failures.\n\n**Note:**\n\n If you assign a message three recipients, the system can fail to deliver the message three times.","example":0,"minimum":0,"type":"integer"},"OWNER":{"description":"The mailbox's account owner.","example":"root","type":"string"},"PRIMARY_DOMAIN":{"description":"The mailbox account's primary domain.","example":"example.com","format":"domain","type":"string"},"REACHED_MAXDEFERFAIL":{"description":"Whether the mailbox reached the maximum number of failed deferred messages.\n* `1` — Reached.\n* `0` — Has **not** reached.","enum":[0,1],"example":1,"type":"integer"},"REACHED_MAXEMAILS":{"description":"Whether the mailbox has reached the maximum number of messages allowed per hour.\n* `1` — Reached.\n* `0` — Has **not** reached.","enum":[0,1],"example":1,"type":"integer"},"SENDCOUNT":{"description":"The number of sent messages.","example":14,"minimum":0,"type":"integer"},"SUCCESSCOUNT":{"description":"The number of successful deliveries.\n\n**Note:**\n\n If you assign a message three recipients, the system can successfully deliver the message three times.","example":14,"minimum":0,"type":"integer"},"TOTALSIZE":{"description":"The total size of messages sent by the server.","example":27444,"format":"bytes","type":"integer"},"USER":{"description":"The mailbox's owner.","example":"example","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"emailtrack_user_stats","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all cPanel accounts email tracking statistics","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n emailtrack_user_stats\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/emailtrack_user_stats?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/emailtrack_stats":{"get":{"description":"This function retrieves email tracking statistics.","operationId":"emailtrack_stats","parameters":[{"description":"The cPanel username to query. If you do not specify a value, the function retrieves statistics for all of the server's accounts.","in":"query","name":"user","required":false,"schema":{"example":"username","type":"string"}},{"description":"The start time of the search window.\n\n**Note**\n\nYou can also call this the `startdate` parameter.","in":"query","name":"starttime","required":false,"schema":{"default":0,"example":1371552781,"format":"unix_timestamp","type":"integer"}},{"description":"The end time of the search window. This parameter defaults to the current time.\n\n**Note**\n\nYou can also call this the `enddate` parameter.","in":"query","name":"endtime","required":false,"schema":{"default":"the current time","example":1471552781,"format":"unix_timestamp","type":"integer"}},{"description":"The type of delivery to query. If you do not specify a value,\nthis function returns all types.\n* `remote`\n* `remote-or-faildefer`\n* `local`","in":"query","name":"deliverytype","required":false,"schema":{"enum":["remote","remote-or-faildefer","local"],"example":"remote","type":"string"}},{"description":"Whether to return the `SUCCESSCOUNT` parameter.\n* 1 — Do **not** return.\n* 0 — Return.","in":"query","name":"nosuccess","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to return the `TOTALSIZE` parameter.\n* 1 — Do **not** return.\n* 0 — Return.","in":"query","name":"nosize","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"records":{"description":"An array of objects containing the message information.","items":{"properties":{"DEFERCOUNT":{"description":"The number of deferral events.","example":0,"minimum":0,"type":"integer"},"DEFERFAILCOUNT":{"description":"The number of messages that the system deferred and failed to deliver.","example":0,"minimum":0,"type":"integer"},"FAILCOUNT":{"description":"The number of delivery failures.\n\n**Note:**\n\n If a message has three recipients, it can have a total of three failed deliveries.","example":0,"minimum":0,"type":"integer"},"INPROGRESSCOUNT":{"description":"The number of messages currently in progress.","example":0,"minimum":0,"type":"integer"},"SENDCOUNT":{"description":"The number of sent messages.","example":14,"minimum":0,"type":"integer"},"SUCCESSCOUNT":{"description":"The number of successful deliveries.\n\n**Note:**\n\n If a message has three recipients, it can have a total of three successful deliveries.","example":14,"type":"integer"},"TOTALSIZE":{"description":"The total size of messages that the server sent.","example":27444,"format":"bytes","minimum":0,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"emailtrack_stats","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account email tracking statistics","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n emailtrack_stats\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/emailtrack_stats?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/listipv6s":{"get":{"description":"This function lists the IPv6 addresses bound to a server’s network interfaces.","operationId":"listipv6s","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"ip":{"description":"An array of objects that contain IPv6 address information.","items":{"properties":{"ip":{"description":"The IPv6 address.","example":"2001:0db8:0:0:1:0:0:1","format":"ipv6","type":"string"}}},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"listipv6s","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return server's IPv6 addresses","tags":["IP Addresses","IPv6 Address Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n listipv6s\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/listipv6s?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/nginxmanager_clear_cache":{"get":{"description":"This function clears a user's NGINX cache","operationId":"nginxmanager_clear_cache","parameters":[{"description":"A list of users whose cache you want to clear.\n\n**Note:**\n\nIf you do not pass this parameter, this function clears the cache for all users.","explode":true,"in":"query","name":"user","required":false,"schema":{"default":[],"example":["unclebob","auntsue"],"format":"username","items":{"format":"username","type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"nginxmanager_clear_cache","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete the user's NGINX cache.","tags":["NGINX Manager"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n nginxmanager_clear_cache\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/nginxmanager_clear_cache?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/getminimumpasswordstrengths":{"get":{"description":"This function retrieves the minimum password strength for cPanel & WHM accounts.","operationId":"getminimumpasswordstrengths","parameters":[{"description":"The service for which to display the minimum password value.\nIf you do not use this parameter, this function returns the minimum password\nsetting for all values.\n* `default` - All services\n* `cpaddons` - cPAddons\n* `createacct` - New cPanel accounts\n* `list` - Mailing lists\n* `mysql` - MySQL® database users\n* `passwd` - WHM user or system accounts\n* `postgres` - PostgreSQL database users\n* `sshkey` - SSH keys\n* `virtual` - Mail, FTP, Web Disk, and WebDAV accounts","in":"query","name":"name","required":false,"schema":{"enum":["default","cpaddons","createacct","list","mysql","passwd","postgres","sshkey","virtual"],"example":"default","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"cpaddons":{"description":"The minimum password strength for cPAddons.","example":50,"maximum":100,"minimum":1,"type":"integer"},"createacct":{"description":"The minimum password strength for new cPanel accounts.","example":50,"maximum":100,"minimum":1,"type":"integer"},"default":{"description":"The minimum password strength for **all** services.","example":50,"maximum":100,"minimum":1,"type":"integer"},"list":{"description":"The minimum password strength for mailing lists.","example":50,"maximum":100,"minimum":1,"type":"integer"},"mysql":{"description":"The minimum password strength for MySQL® database users.","example":50,"maximum":100,"minimum":1,"type":"integer"},"passwd":{"description":"The minimum password strength for WHM user or system accounts.","example":50,"maximum":100,"minimum":1,"type":"integer"},"postgres":{"description":"The minimum password strength for PostgreSQL database users.","example":50,"maximum":100,"minimum":1,"type":"integer"},"sshkey":{"description":"The minimum password strength for SSH keys.","example":50,"maximum":100,"minimum":1,"type":"integer"},"virtual":{"description":"The minimum password strength for mail, FTP, Web Disk, and WebDAV accounts.","example":50,"maximum":100,"minimum":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"getminimumpasswordstrengths","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return minimum password strength","tags":["Passwords"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n getminimumpasswordstrengths\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/getminimumpasswordstrengths?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"82"}},"/addpkgext":{"get":{"description":"This function adds a package extension to a hosting plan (package).\n\n**Notes:**\n\n* If you need to edit a package extension's parameters, call this function again\nwith the same package extension name and the updated package extension variables.\n\n* You can include the extension's variables in your function call, in `key=value` format.\n Consult the extension's documentation for a list of possible variables. Extension variables\n are case-sensitive.","operationId":"addpkgext","parameters":[{"description":"The hosting plan's name.\n\n**Note:**\n\nYou **cannot** use the `extensions` name for a hosting plan.","in":"query","name":"name","required":true,"schema":{"example":"package1","type":"string"}},{"description":"The hosting plan's\n[package extensions](https://go.cpanel.net/GuidetoPackageExtensions).\n\n**Note:**\n\n* Use space-delimited format to add multiple package extensions.\n* Extension names are case-sensitive.","examples":{"multiple":{"summary":"Add multiple package extensions.","value":"extension1 extension2 extension3"},"single":{"summary":"Add a single package extension.","value":"extension1"}},"explode":false,"in":"query","name":"_PACKAGE_EXTENSIONS","required":true,"schema":{"type":"string"},"style":"spaceDelimited"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"pkg":{"description":"The hosting plan's name.","example":"package1","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"addpkgext","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add hosting plan extension","tags":["Packages","Hosting Plan Extensions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n addpkgext \\\n name='package1' \\\n _PACKAGE_EXTENSIONS='extension1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/addpkgext?api.version=1&name=package1&_PACKAGE_EXTENSIONS=extension1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"68"}},"/killpkg":{"get":{"description":"This function deletes a hosting plan (package).","operationId":"killpkg","parameters":[{"description":"The hosting plan's name.\n\n**Note:**\n\n You **cannot** delete a hosting plan that a cPanel account currently uses.","in":"query","name":"pkgname","required":true,"schema":{"example":"package1","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"killpkg","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete hosting plan","tags":["Packages","Hosting Plans"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n killpkg \\\n pkgname='package1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/killpkg?api.version=1&pkgname=package1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/setminimumpasswordstrengths":{"get":{"description":"This function sets the minimum password strength for cPanel & WHM\naccounts.\n\n**Note**\n\nIf you do **not** specify a value for a parameter, the system will retain the existing setting.","operationId":"setminimumpasswordstrengths","parameters":[{"description":"The minimum password strength for all services.","in":"query","name":"default","required":false,"schema":{"example":50,"maximum":100,"minimum":1,"type":"integer"}},{"description":"The minimum password strength for cPAddons.","in":"query","name":"cpaddons","required":false,"schema":{"example":50,"maximum":100,"minimum":1,"type":"integer"}},{"description":"The minimum password strength for new cPanel accounts.","in":"query","name":"createacct","required":false,"schema":{"example":50,"maximum":100,"minimum":1,"type":"integer"}},{"description":"The minimum password strength for mailing lists.","in":"query","name":"list","required":false,"schema":{"example":50,"maximum":100,"minimum":1,"type":"integer"}},{"description":"The minimum password strength for MySQL® database users.","in":"query","name":"mysql","required":false,"schema":{"example":50,"maximum":100,"minimum":1,"type":"integer"}},{"description":"The minimum password strength for WHM user or system accounts.","in":"query","name":"passwd","required":false,"schema":{"example":50,"maximum":100,"minimum":1,"type":"integer"}},{"description":"The minimum password strength for PostgreSQL® database users.","in":"query","name":"postgres","required":false,"schema":{"example":50,"maximum":100,"minimum":1,"type":"integer"}},{"description":"The minimum password strength for SSH keys.","in":"query","name":"sshkey","required":false,"schema":{"example":50,"maximum":100,"minimum":1,"type":"integer"}},{"description":"The minimum password strength for mail, FTP, Web Disk, and WebDAV accounts.","in":"query","name":"virtual","required":false,"schema":{"example":50,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"setminimumpasswordstrengths","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update minimum password strength","tags":["Server Administration","Passwords"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n setminimumpasswordstrengths\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/setminimumpasswordstrengths?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/send_test_posturl":{"get":{"description":"This function uses the specified URL to send a test message through the POST method of HTTP as form data.\nThe function automatically generates a message title and body and includes a unique string in the test message.\nWhen the test message returns, the system searches for the ID string and returns it.\n\nIf the function does not detect the correct ID string in the returned message, the function fails.\n\nThe test's success or failure depends on various conditions. For example:\n* Valid access token.\n* Network configuration.\n* Service outages.\n* External server rate limit.","operationId":"send_test_posturl","parameters":[{"description":"The URL and query string to send in uuencoded format. The system automatically sends the parameter's hostname, subject, and body with the relevant data from the alert.\n\n**Note:**\n\n* To send additional parameters, include those keys after the URL. For example, to send the `apikey` parameter with a value of `XXXXX`, append `?apikey=XXXXX` to the URL.\n* To add additional parameters and values, separate those additional values with the ampersand character (`&`) instead of the question mark character (`?`). For example, to include a `state` parameter of `Texas` and a `status` parameter of `CRITICAL`, append `?apikey=XXXXX&state=Texas&status=CRITICAL` to the URL.\n* If you enter a secure URL (`https://`), that site's certificate **must** be valid.","in":"query","name":"url","required":true,"schema":{"example":"https%3A%2F%2Fwww.example.com%2Fevents.cgi%3Fapikey%3D12345%26user%3Dusername*password%3D12345luggage","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"message_id":{"description":"The test message's ID.","example":"554d2cbd-efe61da3cacb","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"send_test_posturl","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Send notification URL via POST","tags":["Server Administration","Notifications"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n send_test_posturl \\\n url='https%3A%2F%2Fwww.example.com%2Fevents.cgi%3Fapikey%3D12345%26user%3Dusername*password%3D12345luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/send_test_posturl?api.version=1&url=https%253A%252F%252Fwww.example.com%252Fevents.cgi%253Fapikey%253D12345%2526user%253Dusername%2apassword%253D12345luggage"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/package_manager_get_build_log":{"get":{"description":"This function returns build log content.","operationId":"package_manager_get_build_log","parameters":[{"description":"The build process ID returned by the `package_manager_submit_actions` function.","in":"query","name":"build","required":true,"schema":{"example":1234,"minimum":1,"type":"integer"}},{"description":"The position in the build log from which you wish to display entries.","in":"query","name":"offset","required":true,"schema":{"example":4567,"format":"bytes","minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"content":{"description":"The most recent build log entries.","example":["line1","line2","line3"],"items":{"type":"string"},"type":"array"},"offset":{"description":"The last position that the system read in the build log.","example":9672,"format":"bytes","minimum":0,"type":"integer"},"still_running":{"description":"Whether the build process is in progress.\n\n* `1` — In progress.\n* `0` — Complete.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"package_manager_get_build_log","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return RPM management build log","tags":["RPM","Package Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n package_manager_get_build_log \\\n build='1234' \\\n offset='4567'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/package_manager_get_build_log?api.version=1&build=1234&offset=4567"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/package_manager_fixcache":{"get":{"description":"This function attempts to repair yum cache issues.","operationId":"package_manager_fixcache","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"cache_seems_ok_now":{"description":"Whether the system resolved the current error.\n\n* `1` — Resolved.\n\n**Note:**\n\n* The function **only** returns this value if the function succeeds.\n* If the function fails, it **only** returns metadata.","enum":[1],"example":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"package_manager_fixcache","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Repair RPM management yum cache issues","tags":["RPM","Package Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n package_manager_fixcache\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/package_manager_fixcache?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"64"}},"/package_manager_is_performing_actions":{"get":{"description":"This function checks the activity of the process that you executed in the WHM API 1 `package_manager_submit_actions` function.","operationId":"package_manager_is_performing_actions","parameters":[{"description":"The process's build number returned by the WHM API 1 `package_manager_submit_actions` function.","in":"query","name":"build","required":true,"schema":{"example":10053,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"active":{"description":"Whether the process is active.\n\n* `1` — Active.\n* `0` — Inactive.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"package_manager_is_performing_actions","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return RPM package update status","tags":["RPM","List Package Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n package_manager_is_performing_actions \\\n build='10053'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/package_manager_is_performing_actions?api.version=1&build=10053"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/release_outgoing_email":{"get":{"description":"This function releases outgoing email in the email queue for a single cPanel account user.\n\n**Note:**\n\nIf mail for a cPanel user's account is suspended, the system will reject their email before the mail server puts it in queue.","operationId":"release_outgoing_email","parameters":[{"description":"The cPanel account.","in":"query","name":"user","required":true,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"release_outgoing_email","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Release cPanel account queued outgoing emails","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n release_outgoing_email \\\n user='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/release_outgoing_email?api.version=1&user=example"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/package_manager_submit_actions":{"get":{"description":"This function installs, upgrades, or uninstalls RPM packages.\n\n**Note:**\n\nThe system queues this function's actions to run as background tasks. The actions may\nrequire additional time to finish.","operationId":"package_manager_submit_actions","parameters":[{"description":"The RPM package that you want to install. If you do not use this parameter, the function\ndoes not install a package.\n\n**Note:**\n\nYou can pass this parameter multiple times to install more than one RPM package","examples":{"multiple":{"summary":"Install multiple RPM packages.","value":"install=package1 install=package2"},"single":{"summary":"Install a single RPM package.","value":"package1"}},"in":"query","name":"install","required":false,"schema":{"type":"string"}},{"description":"The RPM package that you want to uninstall. If you do not use this parameter, the function\ndoes not uninstall a package.\n\n**Note:**\n\nYou can pass this parameter multiple times to uninstall more than one RPM package.","examples":{"multiple":{"summary":"Uninstall multiple RPM packages.","value":"uninstall=package3 uninstall=package4 uninstall=package5"},"single":{"summary":"Uninstall a single RPM package.","value":"package3"}},"in":"query","name":"uninstall","required":false,"schema":{"type":"string"}},{"description":"The RPM package that you want to upgrade. If you do not use this parameter, the function\ndoes not upgrade a package.\n\n**Note:**\n\nYou can pass this parameter multiple times to upgrade more than one RPM package.","examples":{"multiple":{"summary":"Upgrade multiple RPM packages.","value":"upgrade=package6 upgrade=package7 upgrade=package8"},"single":{"summary":"Upgrade a single RPM package.","value":"package6"}},"in":"query","name":"upgrade","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"build":{"description":"A valid Process ID (PID).","example":9717,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"package_manager_submit_actions","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Start RPM package installation, update, or removal","tags":["RPM","Install or Uninstall Package"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n package_manager_submit_actions\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/package_manager_submit_actions?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/package_manager_list_packages":{"get":{"description":"This function lists information about the system's available RPM packages.","operationId":"package_manager_list_packages","parameters":[{"description":"Return RPM packages that exist in a specified state.\n\n* `any` — All RPMs available on the system.\n* `installed` — The RPMs installed on the system.\n* `not_installed` — The available RPMs not yet installed on the system.\n* `updatable` — The RPMs with updates available.","in":"query","name":"state","schema":{"default":"any","enum":["any","installed","not_installed","updatable"],"example":"installed","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"description":"A list of RPM objects that match the requested `state`.","properties":{"packages":{"description":"An array of objects that contains the RPM packages on the system.","example":[{"package":"MariaDB-client"},{"package":"MariaDB-common"}],"items":{"properties":{"package":{"description":"An RPM package.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"package_manager_list_packages","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return available RPM packages","tags":["RPM","List Package Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n package_manager_list_packages\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/package_manager_list_packages?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/package_manager_upgrade":{"get":{"description":"This function downloads and installs package updates on the server.","operationId":"package_manager_upgrade","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"build":{"description":"A valid Process ID (PID).","example":10111,"type":"integer"}}},"metadata":{"properties":{"command":{"description":"The method name called.","example":"package_manager_upgrade","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Start RPM package upgrade","tags":["RPM","Install or Uninstall Package"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n package_manager_upgrade\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/package_manager_upgrade?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/delpkgext":{"get":{"description":"This function deletes a package extension from a hosting plan (package).\n\n**Note:**\n\n* You can additionally include extension's variables in your function call, in `key=value` format.\n Consult the extension's documentation for a list of possible variables. Extension variable names are case-sensitive.","operationId":"delpkgext","parameters":[{"description":"The hosting plan's name.","in":"query","name":"name","required":true,"schema":{"example":"package1","type":"string"}},{"description":"The space delimited\n[package extensions](https://go.cpanel.net/GuidetoPackageExtensions)\nto delete.\n\n**Note:**\n\n* Extension names are case-sensitive.","explode":true,"in":"query","name":"_DELETE_EXTENSIONS","required":true,"schema":{"example":"extension1 extension2","type":"string"},"style":"spaceDelimited"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"pkg":{"description":"The deleted hosting plan's name.","example":"package1","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"delpkgext","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove hosting plan extension","tags":["Packages","Hosting Plan Extensions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n delpkgext \\\n name='package1' \\\n _DELETE_EXTENSIONS='extension1 extension2'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/delpkgext?api.version=1&name=package1&_DELETE_EXTENSIONS=extension1%20extension2"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"68"}},"/fetchcrtinfo":{"get":{"description":"This function retrieves information about a certificate.","operationId":"fetchcrtinfo","parameters":[{"description":"The cPanel account's username.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The certificate's internal system ID.","in":"query","name":"id","required":true,"schema":{"example":"example_com_bf638_f81af_1500191700_79e34f42c83f748bd49474ab9d66f7cd","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"cabundle":{"description":"The certificate authority (CA) bundle certificate.","example":"-----BEGIN CERTIFICATE-----\nMIIEkjCCA3qgAwIBAgIQCgFBQgAAAVOFc2oLheynCDANBgkqhkiG9w0BAQsFADA/MSQwIgYDVQQK\nExtEaWdpdGFsIFNpZ25hdHVyZSBUcnVzdCBDby4xFzAVBgNVBAMTDkRTVCBSb290IENBIFgzMB4X\nDTE2MDMxNzE2NDA0NloXDTIxMDMxNzE2NDA0NlowSjELMAkGA1UEBhMCVVMxFjAUBgNVBAoTDUxl\ndCdzIEVuY3J5cHQxIzAhBgNVBAMTGkxldCdzIEVuY3J5cHQgQXV0aG9yaXR5IFgzMIIBIjANBgkq\nhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnNMM8FrlLke3cl03g7NoYzDq1zUmGSXhvb418XCSL7e4\nS0EFq6meNQhY7LEqxGiHC6PjdeTm86dicbp5gWAf15Gan/PQeGdxyGkOlZHP/uaZ6WA8SMx+yk13\nEiSdRxta67nsHjcAHJyse6cF6s5K671B5TaYucv9bTyWaN8jKkKQDIZ0Z8h/pZq4UmEUEz9l6YKH\ny9v6Dlb2honzhT+Xhq+w3Brvaw2VFn3EK6BlspkENnWAa6xK8xuQSXgvopZPKiAlKQTGdMDQMc2P\nMTiVFrqoM7hD8bEfwzB/onkxEz0tNvjj/PIzark5McWvxI0NHWQWM6r6hCm21AvA2H3DkwIDAQAB\no4IBfTCCAXkwEgYDVR0TAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwfwYIKwYBBQUHAQEE\nczBxMDIGCCsGAQUFBzABhiZodHRwOi8vaXNyZy50cnVzdGlkLm9jc3AuaWRlbnRydXN0LmNvbTA7\nBggrBgEFBQcwAoYvaHR0cDovL2FwcHMuaWRlbnRydXN0LmNvbS9yb290cy9kc3Ryb290Y2F4My5w\nN2MwHwYDVR0jBBgwFoAUxKexpHsscfrb4UuQdf/EFWCFiRAwVAYDVR0gBE0wSzAIBgZngQwBAgEw\nPwYLKwYBBAGC3xMBAQEwMDAuBggrBgEFBQcCARYiaHR0cDovL2Nwcy5yb290LXgxLmxldHNlbmNy\neXB0Lm9yZzA8BgNVHR8ENTAzMDGgL6AthitodHRwOi8vY3JsLmlkZW50cnVzdC5jb20vRFNUUk9P\nVENBWDNDUkwuY3JsMB0GA1UdDgQWBBSoSmpjBH3duubRObemRWXv86jsoTANBgkqhkiG9w0BAQsF\nAAOCAQEA3TPXEfNjWDjdGBX7CVW+dla5cEilaUcne8IkCJLxWh9KEik3JHRRHGJouM2VcGfl96S8\nTihRzZvoroed6ti6WqEBmtzw3Wodatg+VyOeph4EYpr/1wXKtx8/wApIvJSwtmVi4MFU5aMqrSDE\n6ea73Mj2tcMyo5jMd6jmeWUHK8so/joWUoHOUgwuX4Po1QYz+3dszkDqMp4fklxBwXRsW10KXzPM\nTZ+sOPAveyxindmjkW8lGy+QsRlGPfZ+G6Z6h7mjem0Y+iWlkYcV4PIWL1iwBi8saCbGS5jN2p8M\n+X+Q7UNKEkROb3N6KOqkqm57TH2H3eDJAkSnh6/DNFu0Qg==\n-----END CERTIFICATE-----","type":"string"},"certificate":{"description":"The certificate's text.","example":"-----BEGIN CERTIFICATE-----\nMIIGeDCCBWCgAwIBAgISAxs2uBW3Q2TrGS/aRjTFh90EMA0GCSqGSIb3DQEBCwUAMEoxCzAJBgNV\nBAYTAlVTMRYwFAYDVQQKEw1MZXQncyBFbmNyeXB0MSMwIQYDVQQDExpMZXQncyBFbmNyeXB0IEF1\ndGhvcml0eSBYMzAeFw0xNzA0MTcwNzU1MDBaFw0xNzA3MTYwNzU1MDBaMCUxIzAhBgNVBAMTGm9u\nZWFkYXl1bnRpbHRoZWRheWlkaWUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\nv2OGaQw5oeg2hy0LqfYlBoncBPqElkTfZGqY/2WHoKr5TawPqOlsrLzx17946KGxLs0A3J1rRpi9\nOqrHdv69tj2pFRFC1USjlQmWnUi3h//aTYFNrfDmG+lNWZQ3ALCveTQXYIAvbmwLSPxh6wdtEmU0\nGjbqDNxsI8GSrZcJ543PSTXYFvp7S1yBNSn64S5QB8WeNkLGyF0G+ieXbCJo5neJrNh6+6U+x7mT\n/VBsQDOFOMIskjKo1q56+/elzgSi6lZ5w9IXuQRB3YbbWzCC/kFmzEB/NTe9R5v1AEzdcNwWXpfi\nvlrNIktLQDYIRyHqtyrXl3uR8fvmoYf0ll+BrwIDAQABo4IDezCCA3cwDgYDVR0PAQH/BAQDAgWg\nMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMBAf8EAjAAMB0GA1UdDgQWBBQW\ns0hUTrAJo+db1I2D9K2Aa2O3STAfBgNVHSMEGDAWgBSoSmpjBH3duubRObemRWXv86jsoTBwBggr\nBgEFBQcBAQRkMGIwLwYIKwYBBQUHMAGGI2h0dHA6Ly9vY3NwLmludC14My5sZXRzZW5jcnlwdC5v\ncmcvMC8GCCsGAQUFBzAChiNodHRwOi8vY2VydC5pbnQteDMubGV0c2VuY3J5cHQub3JnLzCCAYMG\nA1UdEQSCAXowggF2giFjcGFuZWwub25lYWRheXVudGlsdGhlZGF5aWRpZS5jb22CH21haWwub25l\nYWRheXVudGlsdGhlZGF5aWRpZS5jb22CHm1wMy5vbmVhZGF5dW50aWx0aGVkYXlpZGllLmNvbYIa\nb25lYWRheXVudGlsdGhlZGF5aWRpZS5jb22CIXJhbmRvbS5vbmVhZGF5dW50aWx0aGVkYXlpZGll\nLmNvbYIid2ViZGlzay5vbmVhZGF5dW50aWx0aGVkYXlpZGllLmNvbYIid2VibWFpbC5vbmVhZGF5\ndW50aWx0aGVkYXlpZGllLmNvbYIed2htLm9uZWFkYXl1bnRpbHRoZWRheWlkaWUuY29tgiJ3d3cu\nbXAzLm9uZWFkYXl1bnRpbHRoZWRheWlkaWUuY29tgh53d3cub25lYWRheXVudGlsdGhlZGF5aWRp\nZS5jb22CJXd3dy5yYW5kb20ub25lYWRheXVudGlsdGhlZGF5aWRpZS5jb20wgf4GA1UdIASB9jCB\n8zAIBgZngQwBAgEwgeYGCysGAQQBgt8TAQEBMIHWMCYGCCsGAQUFBwIBFhpodHRwOi8vY3BzLmxl\ndHNlbmNyeXB0Lm9yZzCBqwYIKwYBBQUHAgIwgZ4MgZtUaGlzIENlcnRpZmljYXRlIG1heSBvbmx5\nIGJlIHJlbGllZCB1cG9uIGJ5IFJlbHlpbmcgUGFydGllcyBhbmQgb25seSBpbiBhY2NvcmRhbmNl\nIHdpdGggdGhlIENlcnRpZmljYXRlIFBvbGljeSBmb3VuZCBhdCBodHRwczovL2xldHNlbmNyeXB0\nLm9yZy9yZXBvc2l0b3J5LzANBgkqhkiG9w0BAQsFAAOCAQEAbfVset/dZ+ru/K2DMa2Od4pCnRYa\nLDREL7TyAWHjHq2fHK1WbzlO9zHis+C0ezB6QBPMnrGDZns/v1njGp1gASly1pqgAsytbQdPbfHv\n/Bx1HRWywniAKSRYFxrc3k3ThrSZxDj+A9mt0znNDNUvRNuP5dGFmQzFACykgNJ58yCeUJZkD78p\n7UjpbpzxWW2m6MHlHu7dDcCwSXpCa6uE4V9TeVs3OSo42C+ZlGH2x3GeZYlOZENmG2nFw0mQFSIW\nATyQuv1Jlc7tiUGmY9o13teTN4YLColMk037Rrwb/mne3ORCPB0k7QtPtzHnCdnRio2NvwZkPXzL\nbioRoW0dQg==\n-----END CERTIFICATE-----","type":"string"},"is_self_signed":{"description":"Whether the certificate is self-signed.\n\n* `1` — Self-signed.\n* `0` — **Not** self-signed.","enum":[1,0],"example":0,"type":"integer"},"key":{"description":"The private key's text.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAv2OGaQw5oeg2hy0LqfYlBoncBPqElkTfZGqY/2WHoKr5TawP\nqOlsrLzx17946KGxLs0A3J1rRpi9OqrHdv69tj2pFRFC1USjlQmWnUi3h//aTYFN\nrfDmG+lNWZQ3ALCveTQXYIAvbmwLSPxh6wdtEmU0GjbqDNxsI8GSrZcJ543PSTXY\nFvp7S1yBNSn64S5QB8WeNkLGyF0G+ieXbCJo5neJrNh6+6U+x7mT/VBsQDOFOMIs\nkjKo1q56+/elzgSi6lZ5w9IXuQRB3YbbWzCC/kFmzEB/NTe9R5v1AEzdcNwWXpfi\nvlrNIktLQDYIRyHqtyrXl3uR8fvmoYf0ll+BrwIDAQABAoIBAG6cIm5LtnMwNXNi\nQT91Fmj0+8eU0VPXchQi11GjaAMfTP3q1xIT9c7PVCYQbtxjtncJ29mk0P73/0UM\ntkK7bwEIGdQnKa0AAlp8NCOqhwd+grgQZsiEVTkEWMPQuQkZFBDEXk5TRxZWMx93\nXU/r9smO29HasuHD8mun0BGrHPpJJm6JE8iMT9wIrr4pYb5TLtXtO/yQ5rxsT5uB\nbmuXAHZ51brj+aIdjrYNAVYHPvVDAjs7aHgKjbLvJ7DJPJKSbkbAEYKqT7lyQO5x\nGtLk1K5qKNHc1sFyybBF/LO1Tn7xTMbSuKce/AUvgE76RZ0nkvCD/kY1l3WBH2ns\nYFsojsECgYEA7UgMJgoKnerhmG/mnZqPUXb78PVgZmt0zmlAYRAcLc8K19xPKVOK\nz4HcDmfkPdkpsdp1YXJ6K/ueJOXq0aCFh2E+uYyqvsMQDFp72poxUPPlJ5zoj3jG\n6N9owoV2CuWX0QbhsE4/Hu5sVjBdE8WuqBBUqKp6602YV8YrA018bSkCgYEAznyq\nLhQujrpeqlN/HRhpNne5r5D8F4wQSZmFP9eRP1pnO2TQqY/wXJgOMKT20CcqwiiY\noVuOmQs1W3dz/MlWHanRKL5cIcF26Pgsp1jimD13JwPU/7nH4+CzJmkXGSHbNmQf\n2wvjv+jni2PbTZ5sotESziaJAdbcRAdg39KnexcCgYEAj086dycNbn9ULZs4L+wP\nr2YrmEa7KGCyNZCAH595RXmM1P7smMsqRVXrMJAy29/zPMXyqx5XB4V66FIs1tsa\nir+DANIitgBeCvgDYe5K5tfHiXtNQonxqOh1/zZYKxCr9sUvPiqkGOxrZkrjjHOS\nn1Ltrsj4YHGHF0xK4j3EbrECgYB403ANqJeZwyqTxmoST295hNNuDYvGB5qcRq43\nLl/6z16q3ZJQNj7zH7Ll+hHGubSGipTNjrLBkVJ2pE6FtBalIvKWQdXNltSK/HW8\nswFdDlKDzPU9cquqB5ktN79hYHNSv4H4fluVt6aN5S+1mqd9GpRDdz8iiWS4lgy0\nzCJenwKBgQC61u/GsjGx4yv0c3KJHgrpIroo3HYsamAdjJBfgBGKxrxVO5J7dbvd\n84UYzp+a0XNjazMxx5rEbU3HjKV5nsHjU+Eoqpz/vwfRqbC7mqINrRQoBKtEhuOY\n+xd6W+i58dOPv7PmgxPegmZ4Fo+jHx+mNLv9L+27JPMBRwRWUxH5TQ==\n-----END RSA PRIVATE KEY-----","type":"string"},"subject.commonName_ip":{"description":"The certificate's IP address.","example":"192.0.2.0","format":"ipv4","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"fetchcrtinfo","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return SSL certificate information","tags":["SSL","cPanel Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n fetchcrtinfo \\\n user='username' \\\n id='example_com_bf638_f81af_1500191700_79e34f42c83f748bd49474ab9d66f7cd'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/fetchcrtinfo?api.version=1&user=username&id=example_com_bf638_f81af_1500191700_79e34f42c83f748bd49474ab9d66f7cd"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.32"}},"/get_users_authn_linked_accounts":{"get":{"description":"This function lists all accounts that link to available external authentication identity providers.","operationId":"get_users_authn_linked_accounts","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"username_linked_accounts":{"description":"An array of objects containing user accounts with their linked identity provider accounts.","items":{"properties":{"link_time":{"description":"When the user linked the account.","example":1443124003,"format":"unix_timestamp","type":"integer"},"preferred_username":{"description":"The preferred username of the account on the identity provider that the interface will display.","example":"username@example.com","type":"string"},"provider_id":{"description":"The system's internal key for the identity provider.","example":"cpanelid","type":"string"},"provider_protocol":{"description":"The identity provider's protocol.","example":"openid_connect","type":"string"},"subject_unique_identifier":{"description":"The unique identifier for the user at the identity provider.","example":"123456789012345678901","type":"string"},"username":{"description":"The cPanel account's username.","example":"username","format":"username","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_users_authn_linked_accounts","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return accounts linked to identity providers","tags":["Authentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_users_authn_linked_accounts\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_users_authn_linked_accounts?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"54"}},"/hold_outgoing_email":{"get":{"description":"This function sets Exim's queue to hold email that a user sends to an external address.\n\n**Note:**\n\n If mail for a cPanel user's account is suspended, the system will reject their email before the mail server puts it in the queue.","operationId":"hold_outgoing_email","parameters":[{"description":"The cPanel account.\n\n**Note**\n\nYou **cannot** suspend the root user's outgoing email with this function.","in":"query","name":"user","required":true,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"hold_outgoing_email","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add cPanel account to outbound email hold queue","tags":["Mail","cPanel Account Mail Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n hold_outgoing_email \\\n user='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/hold_outgoing_email?api.version=1&user=example"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/listlockedaccounts":{"get":{"description":"This function lists locked accounts on the server. **Only** WHM users with\n`root`-level privileges can unsuspend locked accounts.","operationId":"listlockedaccounts","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"account":{"description":"A list of locked accounts on the server.","example":["account1","account2"],"items":{"type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"listlockedaccounts","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result`\nfield is `0`. This field may display a success message when\na function succeeds.","example":"OK","type":"string"},"result":{"description":"- `1` — Success.\n- `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return suspended cPanel accounts","tags":["Suspensions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n listlockedaccounts\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/listlockedaccounts?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.40"}},"/fetchsslinfo":{"get":{"description":"This function retrieves information about SSL certificates that you could install for a user. This function does **not** provide information about the currently installed certificates.","operationId":"fetchsslinfo","parameters":[{"description":"The domain's name.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The certificate's text.","in":"query","name":"crtdata","required":false,"schema":{"example":"-----BEGIN CERTIFICATE-----\\nMIIDdzCCAl+gAwIBAgIFAhQDowAwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL\\nZXhhbXBsZS5jb20wHhcNMTkxMTExMjAzNzUzWhcNMjAxMTEwMjAzNzUzWjAWMRQw\\nEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\\nggEBAK31N5qqd4BhMRm318tt7CP3thvJ9nXv5j3Hks8bfNggAgBmWwh/iGEoyB0e\\nmKmFkomXYQejSCkFmwI5/I+H53LA1UrnWURAHaY8UCJMMeCe22E9fbmASNMhcnov\\n/AOYBl3kEWEkKVBN3dQZFsWzj+PTTui1zHl8nrr1POPLZMS+t8D3HppNoUBwBkKR\\nQ/MetqCaQ3HlgbknMi0/5DbuaV0GJNbXNX9uhnGqQFUI21sEVU4xcvtEDN88dT1d\\nx5EhLXobDV/brXgFm85QK/lZt3aWlIJLs/WJJSK+152PO3HhfoHpkx+JflMYoev5\\nLauXhZGYXCEG8sBLa2PPH9WlpgcCAwEAAaOByzCByDAdBgNVHQ4EFgQU/Vx4Cer1\\nmY3SaijxdCsA2Jo7q84wCQYDVR0TBAIwADBCBgNVHSMEOzA5gBT9XHgJ6vWZjdJq\\nKPF0KwDYmjurzqEapBgwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb22CBQIUA6MAMB0G\\nA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjA5BgNVHREEMjAwggtleGFtcGxl\\nLmNvbYIQbWFpbC5leGFtcGxlLmNvbYIPd3d3LmV4YW1wbGUuY29tMA0GCSqGSIb3\\nDQEBCwUAA4IBAQCneJA732g7srfydkgG0XJ8b1RS3ffVlnG1ahCDfIpBTx2M7Oco\\n0oa4QK4fEJnyh5Zc861aNrRHecLk4KV4QmDmLJVxTKNv3QXqgPJu+zN49x9ESwRs\\nbqiaD+K6MYmlyRukxY+v8jyOhTKvZTOjuuGKhDRcNNgn/kPIjZw3v37vY4o1pUPL\\nP1YBw2Caa01HstzouaVZlw05Viwo2AHJE5u7zW+VcA4VR8WAD/2SqdyWZIo+chwd\\nr3hWlRyHephLCBhOLb1wPk3E+mOIyryXjLpGdVnWewMSEY8AGvv7IORkO5ufCz/c\\n5UlG1r1+l5AhnFQPGoREI49hXVAETVInW9Uk\\n-----END CERTIFICATE-----","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"cab":{"description":"The certificate's certificate authority (CA) bundle.","example":"-----BEGIN CERTIFICATE-----\\nMIIDdzCCAl+gAwIBAgIFAhQDowAwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL\\nZXhhbXBsZS5jb20wHhcNMTkxMTExMjAzNzUzWhcNMjAxMTEwMjAzNzUzWjAWMRQw\\nEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\\nggEBAK31N5qqd4BhMRm318tt7CP3thvJ9nXv5j3Hks8bfNggAgBmWwh/iGEoyB0e\\nmKmFkomXYQejSCkFmwI5/I+H53LA1UrnWURAHaY8UCJMMeCe22E9fbmASNMhcnov\\n/AOYBl3kEWEkKVBN3dQZFsWzj+PTTui1zHl8nrr1POPLZMS+t8D3HppNoUBwBkKR\\nQ/MetqCaQ3HlgbknMi0/5DbuaV0GJNbXNX9uhnGqQFUI21sEVU4xcvtEDN88dT1d\\nx5EhLXobDV/brXgFm85QK/lZt3aWlIJLs/WJJSK+152PO3HhfoHpkx+JflMYoev5\\nLauXhZGYXCEG8sBLa2PPH9WlpgcCAwEAAaOByzCByDAdBgNVHQ4EFgQU/Vx4Cer1\\nmY3SaijxdCsA2Jo7q84wCQYDVR0TBAIwADBCBgNVHSMEOzA5gBT9XHgJ6vWZjdJq\\nKPF0KwDYmjurzqEapBgwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb22CBQIUA6MAMB0G\\nA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjA5BgNVHREEMjAwggtleGFtcGxl\\nLmNvbYIQbWFpbC5leGFtcGxlLmNvbYIPd3d3LmV4YW1wbGUuY29tMA0GCSqGSIb3\\nDQEBCwUAA4IBAQCneJA732g7srfydkgG0XJ8b1RS3ffVlnG1ahCDfIpBTx2M7Oco\\n0oa4QK4fEJnyh5Zc861aNrRHecLk4KV4QmDmLJVxTKNv3QXqgPJu+zN49x9ESwRs\\nbqiaD+K6MYmlyRukxY+v8jyOhTKvZTOjuuGKhDRcNNgn/kPIjZw3v37vY4o1pUPL\\nP1YBw2Caa01HstzouaVZlw05Viwo2AHJE5u7zW+VcA4VR8WAD/2SqdyWZIo+chwd\\nr3hWlRyHephLCBhOLb1wPk3E+mOIyryXjLpGdVnWewMSEY8AGvv7IORkO5ufCz/c\\n5UlG1r1+l5AhnFQPGoREI49hXVAETVInW9Uk\\n-----END CERTIFICATE-----","type":"string"},"crt":{"description":"The certificate's text.","example":"-----BEGIN CERTIFICATE-----\\nMIIDdzCCAl+gAwIBAgIFAhQDowAwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL\\nZXhhbXBsZS5jb20wHhcNMTkxMTExMjAzNzUzWhcNMjAxMTEwMjAzNzUzWjAWMRQw\\nEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\\nggEBAK31N5qqd4BhMRm318tt7CP3thvJ9nXv5j3Hks8bfNggAgBmWwh/iGEoyB0e\\nmKmFkomXYQejSCkFmwI5/I+H53LA1UrnWURAHaY8UCJMMeCe22E9fbmASNMhcnov\\n/AOYBl3kEWEkKVBN3dQZFsWzj+PTTui1zHl8nrr1POPLZMS+t8D3HppNoUBwBkKR\\nQ/MetqCaQ3HlgbknMi0/5DbuaV0GJNbXNX9uhnGqQFUI21sEVU4xcvtEDN88dT1d\\nx5EhLXobDV/brXgFm85QK/lZt3aWlIJLs/WJJSK+152PO3HhfoHpkx+JflMYoev5\\nLauXhZGYXCEG8sBLa2PPH9WlpgcCAwEAAaOByzCByDAdBgNVHQ4EFgQU/Vx4Cer1\\nmY3SaijxdCsA2Jo7q84wCQYDVR0TBAIwADBCBgNVHSMEOzA5gBT9XHgJ6vWZjdJq\\nKPF0KwDYmjurzqEapBgwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb22CBQIUA6MAMB0G\\nA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjA5BgNVHREEMjAwggtleGFtcGxl\\nLmNvbYIQbWFpbC5leGFtcGxlLmNvbYIPd3d3LmV4YW1wbGUuY29tMA0GCSqGSIb3\\nDQEBCwUAA4IBAQCneJA732g7srfydkgG0XJ8b1RS3ffVlnG1ahCDfIpBTx2M7Oco\\n0oa4QK4fEJnyh5Zc861aNrRHecLk4KV4QmDmLJVxTKNv3QXqgPJu+zN49x9ESwRs\\nbqiaD+K6MYmlyRukxY+v8jyOhTKvZTOjuuGKhDRcNNgn/kPIjZw3v37vY4o1pUPL\\nP1YBw2Caa01HstzouaVZlw05Viwo2AHJE5u7zW+VcA4VR8WAD/2SqdyWZIo+chwd\\nr3hWlRyHephLCBhOLb1wPk3E+mOIyryXjLpGdVnWewMSEY8AGvv7IORkO5ufCz/c\\n5UlG1r1+l5AhnFQPGoREI49hXVAETVInW9Uk\\n-----END CERTIFICATE-----","type":"string"},"crt_origin":{"description":"The username of the certificate's creator.","example":"example","format":"username","type":"string"},"domain":{"description":"The domain name on the certificate.","example":"example.com","format":"domain","type":"string"},"ip":{"description":"The certificate's IP address.","example":"192.168.0.20","format":"ipv4","type":"string"},"key":{"description":"The certificate's private key.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEArfU3mqp3gGExGbfXy23sI/e2G8n2de/mPceSzxt82CACAGZb\nCH+IYSjIHR6YqYWSiZdhB6NIKQWbAjn8j4fncsDVSudZREAdpjxQIkwx4J7bYT19\nuYBI0yFyei/8A5gGXeQRYSQpUE3d1BkWxbOP49NO6LXMeXyeuvU848tkxL63wPce\nmk2hQHAGQpFD8x62oJpDceWBuScyLT/kNu5pXQYk1tc1f26GcapAVQjbWwRVTjFy\n+0QM3zx1PV3HkSEtehsNX9uteAWbzlAr+Vm3dpaUgkuz9YklIr7XnY87ceF+gemT\nH4l+Uxih6/ktq5eFkZhcIQbywEtrY88f1aWmBwIDAQABAoIBAD9rmDMOFPU7+d+r\nc8QZti7Cv6TP88e5h5JccTyKg/BzcudcabHmdP0fFh3vqq6bIPqCswBK2iMChSnB\npD9bx9jBTsG5KIVGbsjNUlW+u6xtngOMnIqFp4c5uXesiM9ynFecr21f9qPtT4Nl\nBjVbqojf3/PdW8eq1F/KysEtxPYpC/RI35iL0zl8EBZ5Ydn0Yb6ftr2e72mf8JDx\nN6SgQt3E7vviRSmivuURmN9KjD+grf94fiL7PDONL/ectOWrvXnD7ppmngNuae2m\n34OHraSM46QzOp/egFc0yyNQC2PKb4YxYMq7U2ijU2rM4d809HI9jG2BXmB1I2YO\no5vZK4kCgYEA2mggZsJs7L67NXryrDNm82RnoPEjoTT2zdzl92BvMYVmu2cRyi/m\n2X5HDzTlc3l8fqFERSSc/Vc/hjluaDT+vbJzNa1tFklMbb3rXW1Z6fhqadQf34jz\nAXjeUU90aCIgAcFyTVdiz12pS1ESNCeGlRFIBF5Z3nK3MV/JmUNjEBsCgYEAy+Z/\nAtRAc6YcYseVEyo0wq2NNfDStYNp7+GhcA8qp4+1pZ8dk7n9VfkSUem0WEoi7F7g\nlUVDsWr62XiFtkV3dv77CUTlXcjmReykTzvPclT9wqyj84F09FdPZ5XusiQ0GKPe\nwLUWv+NPFlarZSxvRedlwPnC3O7FrN9TAV0/WIUCgYEAwpa/N47GKXANr6ppB8+M\nTBIK2jO+QOTFd8j2Ax8iMobebt131iIzlVeSzBOe0vFMYC4ie1ARpw3TBS2qFqIQ\nzMZvK0XmyVJpC+WIC+dfkrvHY56g/zIvAALGYL9fwV+WELpfslTHLmYObZI/m8QT\nfkC1X18Ixs6CNTVYknqdij0CgYA+btZnJFyTzMIWUOxJkPvUvFVntdSe9Z0jcWAA\nMvSpl+xTyTPCPwneIETGxhuNiS3GWIrFyg6fLZWfrzKqC/03d32gafMdU12G/Z2W\nEUdEx9dnm3scHYCVLILIwfTzoPg+rzaOpSRRHyXhPip+8SslKWRTwWY0RfxLIZqF\n6WpzDQKBgQDIFver+WSw/LTHt8LvYWyWi7pOIu6Df0ff1AYYSTMzsz9UewfRlSFw\n/ASp0dR6Po84oxIYRERxbu1ZoDhQxnGb5M1i+iFsOYBIRVmbWs4k7A0kghjGqciA\nyIbJNfSVmgNTXN4VqXW1rAqYDGDgE+huGEpnD08bPfEQm9tp0Mss5w==\n-----END RSA PRIVATE KEY-----","type":"string"},"key_origin":{"description":"The username of the key's creator.","example":"example","format":"username","type":"string"},"searched_users":{"description":"A list of users that the system searched to find certificate information.","example":["root","example"],"items":{"format":"username","type":"string"},"type":"array"},"user":{"description":"The certificate's owner.","example":"example","format":"username","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"fetchsslinfo","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account SSL certificate information","tags":["SSL","cPanel Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n fetchsslinfo\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/fetchsslinfo?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.32"}},"/killdns":{"get":{"description":"This function deletes a DNS zone.\n\n**Important:**\n\n- The WHM API 1 adddns function adds an XDNS entry for a domain in the following locations:\n - The `/var/cpanel/users/USER` file, where `USER` represents the domain's owner.\n - The `/etc/vdomainaliases/DOMAIN` directory, where `DOMAIN` represents the new zone's domain.\n - The `/etc/vfilters/DOMAIN` directory, where `DOMAIN` represents the new zone's domain.\n- This function does **not** automatically delete these entries. You **must** manually delete these entries, or you **cannot** use this domain as a value in other API functions.\n- You cannot delete other DNS zones that reside on *Write-only* servers in a DNS cluster.\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"killdns","parameters":[{"description":"The zone record's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"killdns","type":"string"},"output":{"properties":{"raw":{"description":"The raw response output.","example":"example.com => deleted from example.","type":"string"}},"type":"object"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Zones Removed","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete DNS zone","tags":["DNS","DNS Zones"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n killdns \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/killdns?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/listmxs":{"get":{"description":"This function lists a domain's MX records.\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"listmxs","parameters":[{"description":"The zone record's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"record":{"description":"An array of zone record data objects.","items":{"properties":{"Line":{"description":"The zone record's line number.","example":1,"minimum":1,"type":"integer"},"class":{"description":"The record's class.","example":"IN","type":"string"},"exchange":{"description":"The domain's mail exchanger.","example":"mail.example.com","format":"domain","type":"string"},"name":{"description":"The record's name.","example":"hostname.example.com","type":"string"},"preference":{"description":"The MX record's priority order.\n\n**Note:**\n\nLower values indicate a higher priority order.","example":20,"minimum":1,"type":"integer"},"ttl":{"description":"The record's Time To Live (TTL) in seconds.","example":86400,"minimum":1,"type":"integer"},"type":{"description":"The DNS record's type.","example":"MX","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"listmxs","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Records obtained.","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domain's mail exchanger records","tags":["DNS","Domain Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n listmxs \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/listmxs?api.version=1&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/personalization_get":{"post":{"description":"This function retrieves the data from an NVData file on disk. cPanel\nNVData is a per-account configuration storage mechanism that you can use to\nmaintain persistent cPanel & WHM settings across multiple sessions. This includes\ncustom settings for your own themes.\n\n**Note:**\n\nYou can **only** call this function as a JSON request. For more information about\nadditional output options, run the `whmapi1 --help` command.","operationId":"personalization_get","requestBody":{"content":{"application/json":{"schema":{"properties":{"names":{"description":"A list of NVData keys stored on the server.\n\n**Note:**\n\nIf you did **not** set a value for the requested keys, the system returns\na null value.","example":["milk","coffee"],"items":{"type":"string"},"maxLength":2048,"nullable":true,"type":"array"},"store":{"description":"The name under which the values are stored.","example":"beverages","maxLength":128,"type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"example":{"personalization":{"coffee":{"reason":"OK","success":1,"value":"hot"},"milk":{"reason":"OK","success":1,"value":"cold"}}},"properties":{"personalization":{"description":"The NVData keys and values stored on the server.","properties":{"additionalProperties":{"description":"The retrieved NVData information stored on the server.\n\n**Note:**\n\nThis return's name is based on the keys provided in the `personalization`\nparameter with WHM API 1's `personalization_set` function.","properties":{"reason":{"description":"An error message describing the failure if the `success` Boolean returns a `0` value.","format":"string"},"success":{"description":"Whether the function successfully retrieved the value from\nthe server.\n\n* `1` — Successful.\n* `0` — Unsuccessful.","enum":[1,0],"type":"integer"},"value":{"description":"The value stored in the field.\n\n* null — The pair is **not** available in the store.","nullable":true,"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"personalization_get","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return data from NVData file","tags":["Server Administration","Account Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"echo '{\"names\":[\"milk\",\"coffee\"],\"store\":\"beverages\"}' | \\\nwhmapi1 --input=json --output=jsonpretty \\\n personalization_get"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/json-api/personalization_get HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 65\n\n{\"api.version\":\"1\",\"names\":[\"milk\",\"coffee\"],\"store\":\"beverages\"}"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"74"}},"/personalization_set":{"post":{"description":"This function is used to save personalization data for a WHM user to a\ndatastore on disk.\n\nWe call this system cPanel NVData. \n\ncPanel NVData is a per-login configuration storage mechanism that you can use to\nmaintain persistent user interface settings across multiple sessions.\n\nThis includes custom settings for your own themes and plugins.\n\nThis function is used to save personalzation data for WHM users **only**. If you want to save personalization data for cPanel users, use the\nUAPI function `personalization_set`.","operationId":"personalization_set","requestBody":{"content":{"application/json":{"schema":{"example":{"api.version":1,"personalization":{"coffee":"hot","milk":"cold"},"store":"beverages"},"properties":{"api.version":{"description":"The WHM API version number","enum":[1],"type":"integer"},"personalization":{"description":"An object you want to store.","type":"object"},"store":{"description":"The name under which the values will be stored.","example":"beverages","maxLength":128,"type":"string"}},"required":["api.version","personalization"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"personalization":{"additionalProperties":{"description":"The name for this property is one of the properties that you provide in the personalization parameter.","properties":{"reason":{"description":"The message that describes the failure if the `success` property returns `0`.","example":"OK","type":"string"},"success":{"description":"Whether the function successfully saved the value on the server.\n* `1` - Successful.\n* `0` - Unsuccessful.","enum":[0,1],"example":1,"type":"integer"},"value":{"description":"The value stored in the field or `null` if the property is not available in the datastore.","example":"hot","nullable":true,"type":"string"}},"type":"object"},"description":"The saved personalization information on the server.","example":{"coffee":{"reason":"OK","success":1,"value":"hot"},"milk":{"reason":"OK","success":1,"value":"cold"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"personalization_set","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Save data to NVData file","tags":["Server Administration","Account Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"echo '{\"api.version\":\"1\",\"personalization\":{\"coffee\":\"hot\",\"milk\":\"cold\"},\"store\":\"beverages\"}' | \\\nwhmapi1 --input=json --output=jsonpretty \\\n personalization_set"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/json-api/personalization_set HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 87\n\n{\"api.version\":\"1\",\"personalization\":{\"coffee\":\"hot\",\"milk\":\"cold\"},\"store\":\"beverages\"}"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"74"}},"/install_rpm_plugin":{"get":{"description":"This function starts a plugin installation. The installation runs as a background process.","operationId":"install_rpm_plugin","parameters":[{"description":"The name of a plugin RPM to install.","in":"query","name":"name","required":true,"schema":{"example":"plugin name","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"log_entry":{"description":"The name of the RPM plugin log entry for this installation, which includes a timestamp.","example":"2017-01-01T19:39:27Z_plugin_name","type":"string"},"pid":{"description":"The PID of the process that will install the RPM.","example":1234,"minimum":0,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"install_rpm_plugin","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Install WHM plugin RPM package","tags":["RPM","Install or Uninstall Package"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n install_rpm_plugin \\\n name='plugin name'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/install_rpm_plugin?api.version=1&name=plugin%20name"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"64"}},"/uninstall_rpm_plugin":{"get":{"description":"This function starts the uninstall process for a plugin. The uninstall process runs as a background process.","operationId":"uninstall_rpm_plugin","parameters":[{"description":"The name of a plugin RPM to uninstall.","in":"query","name":"name","required":true,"schema":{"example":"plugin_name","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"log_entry":{"description":"The name of the RPM plugin log entry for this uninstall process, including a timestamp.","example":"2017-01-01T19:39:27Z_plugin_name","type":"string"},"pid":{"description":"The PID of the process that is doing the removal.","example":1234,"minimum":0,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"uninstall_rpm_plugin","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Uninstall WHM plugin RPM package","tags":["RPM","Install or Uninstall Package"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n uninstall_rpm_plugin \\\n name='plugin_name'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/uninstall_rpm_plugin?api.version=1&name=plugin_name"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"64"}},"/get_users_links":{"get":{"description":"This function returns a list of\n[application keys](https://go.cpanel.net/jupiter-appkeys)\n(appkeys) and the URLs that correspond to applications for the cPanel user's theme.\nUse the appkey values for the `app` parameter's value in the WHM API 1 `create_user_session`\nfunction.","operationId":"get_users_links","parameters":[{"description":"The requested user's username.","in":"query","name":"user","required":true,"schema":{"example":"user","type":"string"}},{"description":"The interface for which to filter results:\n\n* `cpanel` — cPanel\n* `webmail` — Webmail","in":"query","name":"service","required":false,"schema":{"default":"cpaneld","enum":["cpaneld","webmail"],"example":"cpaneld","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"additionalProperties":{"description":"The name of the appkey and its corresponding URL to the specific\napplication.\n\n**Note:**\n\nThis function returns this value as the appkey name and the appkey's\napplication URL.","type":"string"},"description":"A list of appkeys and their corresponding file locations.","example":{"Backups_Home":"frontend/jupiter/backup/index.html","Calendar_Configure":"frontend/jupiter/mail/calendars_and_contacts/index.html","ContactInfo_Change":"frontend/jupiter/contact/index.html","Cron_Home":"frontend/jupiter/cron/index.html","Database_MySQL":"frontend/jupiter/sql/index.html","Database_phpMyAdmin":"frontend/jupiter/sql/PhpMyAdmin.html","Email_AccountLevelFiltering":"frontend/jupiter/mail/filters/userfilters.html","Email_Accounts":"frontend/jupiter/mail/pops/index.html","Email_Archive":"frontend/jupiter/mail/archive.html","Email_Authentication":"frontend/jupiter/mail/auth.html","Email_AutoResponders":"frontend/jupiter/mail/autores.html","Email_BoxTrapper":"frontend/jupiter/mail/boxtrapper.html","Email_DefaultAddress":"frontend/jupiter/mail/def.html","Email_DeliveryReport":"frontend/jupiter/mail/def.html","Email_Disk_Usage":"frontend/jupiter/mail/manage_disk_usage/","Email_Forwarders":"frontend/jupiter/mail/fwds.html","Email_GreyListing":"frontend/jupiter/mail/greylisting/index.html","Email_MailingLists":"frontend/jupiter/mail/lists.html","Email_Routing":"frontend/jupiter/mail/email_routing.html","Email_SpamFilter":"frontend/jupiter/mail/spam/spam.html","Email_UserLevelFiltering":"frontend/jupiter/mail/filters/managefilters.html","FileManager_Home":"frontend/jupiter/filemanager/index.html","Locale_Change":"frontend/jupiter/setlang/index.html","Password_Change":"frontend/jupiter/passwd/index.html","SSL_TLS_Manager":"frontend/jupiter/ssl/index.html","SSL_TLS_Status":"frontend/jupiter/security/tls_status/","SSL_TLS_Wizard":"frontend/jupiter/security/tls_wizard/","Site_Software":"frontend/jupiter/addoncgi/cpaddons.html","Solr_Disk_Usage":"frontend/jupiter/mail/search_index/","Stats_AWStats":"frontend/jupiter/stats/awstats_landing.html"},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_users_links","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account theme's app keys and URLs","tags":["Styles"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_users_links \\\n user='user'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_users_links?api.version=1&user=user"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.50"}},"/get_public_contact":{"get":{"description":"This function retrieves an account's [public contact information](https://docs.cpanel.net/whm/cpanel/customization/#public-contact).","operationId":"get_public_contact","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"name":{"description":"The public contact name of the reseller.","example":"Bob's Hosting","type":"string"},"url":{"description":"The public contact URL.","example":"https://bobshosting.net","format":"url","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_public_contact","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return current user's public contact information","tags":["Resellers","Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_public_contact\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_public_contact?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"68"}},"/set_public_contact":{"get":{"description":"This function sets an account's public contact information.","operationId":"set_public_contact","parameters":[{"description":"The public contact name of the reseller. If you do not use this\nparameter, the system retains the current setting.","in":"query","name":"name","required":false,"schema":{"example":"Bob's Hosting","type":"string"}},{"description":"The public contact URL. If you do not use this parameter, the\nsystem retains the current setting.","in":"query","name":"url","required":false,"schema":{"example":"https://bobshosting.net","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"set_public_contact","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result`\nfield is `0`. This field may display a success message when\na function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update current user's public contact information","tags":["Resellers","Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n set_public_contact\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/set_public_contact?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"68"}},"/quota_enabled":{"get":{"description":"This function checks if quotas are enabled on at least one of a user's /home directory mounts.","operationId":"quota_enabled","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"quota_enabled":{"description":"Whether quotas are enabled.\n* 1 - Enabled.\n* 0 - Disabled.","enum":[0,1],"example":0,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"quota_enabled","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* 1 - Success\n* 0 - Failed. Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate cPanel account quotas","tags":["Bandwidth and Disk Quotas"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n quota_enabled\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/quota_enabled?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/get_rpm_version_data":{"get":{"description":"This function lists a key's available RPMs. For more information, read our\n[rpm.versions system](https://go.cpanel.net/rpm-versions)\ndocumentation.","operationId":"get_rpm_version_data","parameters":[{"description":"The RPM's section.","in":"query","name":"section","required":true,"schema":{"example":"rpm_groups","type":"string"}},{"description":"The RPM's key. If you do **not** specify a value, the function returns all RPM categories.","in":"query","name":"key","required":false,"schema":{"example":"3rdparty","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"description":"The RPM section and its associated RPMs.\n\n**Note:**\n\n* This function uses the RPM section's name and RPM key's name for each return value.\n* If you specify the `key` parameter, this function returns **only** the called RPM key.\n* If you do **not** specify the `key` parameter, the function returns **all** RPM keys\nin the called `section` parameter. ","oneOf":[{"additionalProperties":{"description":"A list of all available RPMs. The system uses the RPM key's name as the return name.","items":{"type":"string"},"type":"array"},"example":{"3rdparty":["cpanel-pcre","cpanel-pixman","cpanel-analog"]}},{"additionalProperties":{"additionalProperties":{"description":"A list of all available RPMs. The system uses the RPM key's name as the return name.","items":{"type":"string"},"type":"array"},"description":"A list containing the RPM section's RPM information. The system uses the RPM section name as the return name.","type":"object"},"example":{"rpm_groups":{"3rdparty":["cpanel-pcre","cpanel-pixman","cpanel-analog"]}}}]},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_rpm_version_data","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return available RPM packages","tags":["RPM","List Package Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_rpm_version_data \\\n section='rpm_groups'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_rpm_version_data?api.version=1§ion=rpm_groups"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.32"}},"/delete_rpm_version":{"get":{"description":"This function removes RPM data. When you call this function, it performs the same\nactions as the following command:\n\n`/usr/local/cpanel/scripts/update_local_rpm_versions --del section.key value`\n\nFor more information, read our\n[rpm.versions system](https://docs.cpanel.net/knowledge-base/rpm-versions/introduction-to-the-rpm-versions-system/)\ndocumentation.\n\n**Note:**\n\nAfter you call this function, we **strongly** recommend that you run the\n`/usr/local/cpanel/scripts/check_cpanel_pkgs` script.","operationId":"delete_rpm_version","parameters":[{"description":"The RPM's section within the `rpm.versions` file.","in":"query","name":"section","required":true,"schema":{"example":"rpm_groups","type":"string"}},{"description":"The [RPM's target](https://docs.cpanel.net/knowledge-base/rpm-versions/rpm-targets/).","in":"query","name":"key","required":true,"schema":{"example":"3rdparty","type":"string"}},{"description":"The RPM name.","in":"query","name":"value","required":true,"schema":{"example":"cpanel-pcre","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"status":{"description":"Whether the function was successful.\n\n* `1` — Success.\n* `0` — Failure.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"delete_rpm_version","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove rpm.versions system configuration","tags":["RPM","Package Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n delete_rpm_version \\\n section='rpm_groups' \\\n key='3rdparty' \\\n value='cpanel-pcre'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_rpm_version?api.version=1§ion=rpm_groups&key=3rdparty&value=cpanel-pcre"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.32"}},"/edit_rpm_version":{"get":{"description":"This function edits RPM data. When you call this function, it performs the same actions\nas the following command:\n\n`/usr/local/cpanel/scripts/update_local_rpm_versions --edit section.key value`\n\nFor more information, read our\n[rpm.versions system](https://docs.cpanel.net/knowledge-base/rpm-versions/introduction-to-the-rpm-versions-system/)\ndocumentation.\n\n**Note:**\n\nAfter you call this function, we **strongly** recommend that you run the\n`/usr/local/cpanel/scripts/check_cpanel_pkgs` script.","operationId":"edit_rpm_version","parameters":[{"description":"The RPM's section.","in":"query","name":"section","required":true,"schema":{"example":"rpm_groups","type":"string"}},{"description":"The RPM's key.","in":"query","name":"key","required":true,"schema":{"example":"3rdparty","type":"string"}},{"description":"The RPM's value.","in":"query","name":"value","required":true,"schema":{"example":"cpanel-pcre","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"status":{"description":"Whether the function succeeded.\n\n* `1` — Success.\n* `0` — Failure.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"edit_rpm_version","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update rpm.versions system configuration","tags":["RPM","Package Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n edit_rpm_version \\\n section='rpm_groups' \\\n key='3rdparty' \\\n value='cpanel-pcre'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/edit_rpm_version?api.version=1§ion=rpm_groups&key=3rdparty&value=cpanel-pcre"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.32"}},"/list_rpms":{"get":{"description":"This function lists RPMs that the server needs, but the server owner has not yet installed.\nWhen you call this function, it performs the same actions as the following command:\n\n`/usr/local/cpanel/scripts/check_cpanel_pkgs --list-only --targets[target]`\n\nFor more information, read our\n[rpm.versions system](https://docs.cpanel.net/knowledge-base/rpm-versions/introduction-to-the-rpm-versions-system/)\ndocumentation.","operationId":"list_rpms","parameters":[{"description":"The target that depends on the uninstalled RPMs. If you do not specify a value, the function lists all of the required but uninstalled RPMs for all RPM targets.","in":"query","name":"target","required":false,"schema":{"example":"3rdparty","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"rpms":{"description":"A list of all RPM dependencies that the server owner has not yet installed.","items":{"example":"cpanel-pcre","type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"list_rpms","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return required but uninstalled server RPM package","tags":["RPM","List Package Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n list_rpms\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/list_rpms?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.32"}},"/get_password_strength":{"get":{"description":"This function measures the strength of a password.","operationId":"get_password_strength","parameters":[{"description":"The password.","in":"query","name":"password","required":true,"schema":{"example":"12345luggage","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"strength":{"description":"The password's strength.","example":21,"maximum":100,"minimum":0,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_password_strength","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"- 1 - Success\n- 0 - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return password strength","tags":["Passwords"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_password_strength \\\n password='12345luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_password_strength?api.version=1&password=12345luggage"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/link_user_authn_provider":{"get":{"description":"This function adds an External Authentication authorization link to an account.","operationId":"link_user_authn_provider","parameters":[{"description":"The account's 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":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"link_user_authn_provider","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add identity provider to cPanel account","tags":["Authentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n link_user_authn_provider \\\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:2087/cpsess##########/json-api/link_user_authn_provider?api.version=1&username=example&provider_id=google&subject_unique_identifier=123456789012345678901&preferred_username=Example"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"56"}},"/remote_mysql_delete_profile":{"get":{"description":"This function deletes a specified remote MySQL® profile.","operationId":"remote_mysql_delete_profile","parameters":[{"description":"The profile's name.","in":"query","name":"name","required":true,"schema":{"example":"MyProfile","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"profile_deleted":{"description":"The deleted profile's name. A valid string.","example":"MyProfile","type":"string"},"profile_details":{"description":"hash of the deleted profile's data. This hash includes the name , mysql_host , mysql_user , mysql_pass , mysql_port , setup_via , and active returns.","properties":{"active":{"description":"Whether the system uses this profile to access the MySQL server.\n- 1 Active.\n- 0 Not active.","enum":[0,1],"example":0,"type":"integer"},"mysql_host":{"description":"The MySQL server's IP address or hostname. A valid IP address or hostname.","example":"192.168.0.1","type":"string"},"mysql_pass":{"description":"The MySQL server's password. A valid string.","example":"12345luggage","type":"string"},"mysql_port":{"description":"The MySQL server's port. A valid positive integer.","example":3306,"type":"integer"},"mysql_user":{"description":"The MySQL server's username. A valid string.","example":"username","type":"string"},"setup_via":{"description":"description of the profile data. A valid string with a maximum length of 255 characters.","example":"Main terminal","type":"string"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"remote_mysql_delete_profile","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete remote MySQL profile","tags":["Databases","Remote MySQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n remote_mysql_delete_profile \\\n name='MyProfile'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_delete_profile?api.version=1&name=MyProfile"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/remote_mysql_initiate_profile_activation":{"get":{"description":"This function initiates the activation process for a remote MySQL® profile.","operationId":"remote_mysql_initiate_profile_activation","parameters":[{"description":"The profile's name.","in":"query","name":"name","required":true,"schema":{"example":"MyProfile","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"activation_job_started":{"description":"The profile activation's process ID.","example":8093,"minimum":1,"type":"integer"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"remote_mysql_initiate_profile_activation","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Start remote MySQL profile activation","tags":["Databases","Remote MySQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n remote_mysql_initiate_profile_activation \\\n name='MyProfile'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_initiate_profile_activation?api.version=1&name=MyProfile"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/remote_mysql_read_profile":{"get":{"description":"This function displays the details of a specified remote MySQL® profile.","operationId":"remote_mysql_read_profile","parameters":[{"description":"The MySQL profile's name.","in":"query","name":"name","required":true,"schema":{"example":"MyProfile","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"profile_details":{"description":"An object containing the profile's data.","properties":{"active":{"description":"Whether the system uses this profile to access the MySQL server.\n\n* `1` — The system uses the profile.\n* `0` — The system does **not** use the profile.","enum":[1,0],"example":0,"type":"integer"},"mysql_host":{"description":"The MySQL server's IP address or hostname.","oneOf":[{"description":"A valid IP address.","example":"192.168.0.1","format":"ipv4","type":"string"},{"description":"A valid hostname.","example":"hostname.example.com","format":"hostname","type":"string"}],"type":"string"},"mysql_pass":{"description":"The MySQL server's password.","example":"123456luggage","type":"string"},"mysql_port":{"description":"The MySQL server's port number.","example":3306,"maximum":65535,"minimum":1,"type":"integer"},"mysql_user":{"description":"The MySQL server's username.","example":"username","type":"string"},"setup_via":{"description":"A description of the MySQL profile data.","example":"Main terminal","maxLength":255,"type":"string"}},"type":"object"},"profile_name":{"description":"The MySQL profile's name.","example":"MyProfile","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"remote_mysql_read_profile","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return remote MySQL profile","tags":["Databases","Remote MySQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n remote_mysql_read_profile \\\n name='MyProfile'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_read_profile?api.version=1&name=MyProfile"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/remote_mysql_monitor_profile_activation":{"get":{"description":"This function reports the current status of the remote MySQL® profile activation process. The activation process contains several steps that take some time to complete, so so you may need to call this function multiple times multiple times to monitor the progress.","operationId":"remote_mysql_monitor_profile_activation","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"job_in_progress":{"description":"An object containing the profile activation that is currently in progress.","properties":{"profile_name":{"description":"The the name of the activated profile.","example":"remote_server","type":"string"},"start_time":{"description":"The time when the job started.","example":1432064519,"format":"unix_timestamp","type":"integer"},"status":{"description":"The job's current status.\n* `DONE` — The process completed successfully.\n* `INPROGRESS` — The process is currently active.\n* `FAILED` — The process failed to complete successfully.","enum":["DONE","INPROGRESS","FAILED"],"example":"INPROGRESS","type":"string"},"steps":{"description":"An array of objects containing the completed or active processes for the current profile activation.","items":{"properties":{"end_time":{"description":"The time when the process finished.","example":1432064520,"format":"unix_timestamp","type":"integer"},"name":{"description":"The name of the process.","example":"Updating /root/.my.cnf","type":"string"},"start_time":{"description":"The time when the process began.","example":1432064519,"format":"unix_timestamp","type":"integer"},"status":{"description":"The process's current status.\n* `DONE` — The process completed successfully.\n* `INPROGRESS` — The process is currently active.\n* `FAILED` — The process failed to complete successfully.","enum":["DONE","INPROGRESS","FAILED"],"example":"DONE","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"last_job_details":{"description":"An object containing the most recently completed profile activation's data.","properties":{"end_time":{"description":"The time when the job finished.","example":1432220941,"format":"unix_timestamp","type":"integer"},"profile_name":{"description":"The the name of the activated profile.","example":"MyProfile","type":"string"},"start_time":{"description":"The time when the job started.","example":1432064519,"format":"unix_timestamp","type":"integer"},"status":{"description":"The job's current status.\n* `DONE` — The process completed successfully.\n* `INPROGRESS` — The process is currently active.\n* `FAILED` - The process failed to complete successfully.","enum":["DONE","INPROGRESS","FAILED"],"example":"DONE","type":"string"},"steps":{"description":"An array of objects containing the completed processes for the most recent profile activation.","items":{"properties":{"end_time":{"description":"The time when the process finished.","example":1432220941,"format":"unix_timestamp","type":"integer"},"name":{"description":"The name of the process.","type":"string"},"start_time":{"description":"The time when the process began.","example":1432220941,"format":"unix_timestamp","type":"integer"},"status":{"description":"The process's current status.\n* `DONE` — The process completed successfully.\n* `INPROGRESS` - The process is currently active.\n* `FAILED` - The process failed to complete successfully.","example":"DONE","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"remote_mysql_monitor_profile_activation","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return remote MySQL profile activation","tags":["Databases","Remote MySQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n remote_mysql_monitor_profile_activation\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_monitor_profile_activation?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/remote_mysql_update_profile":{"get":{"description":"This function updates one or more parameters for a remote MySQL®\nprofile.\n\n**Note:**\nThis function requires the `name` parameter **and** one of more of the `mysql_host` , `mysql_user`, `mysql_pass`, `mysql_port`, or `setup_via` parameters.","operationId":"remote_mysql_update_profile","parameters":[{"description":"The profile's name.","in":"query","name":"name","required":true,"schema":{"example":"MyProfile","type":"string"}},{"description":"The MySQL server's IP address or hostname.","in":"query","name":"mysql_host","required":false,"schema":{"example":"192.168.0.1","oneOf":[{"format":"ipv4","type":"string"},{"format":"hostname","type":"string"}]}},{"description":"The MySQL server's username.","in":"query","name":"mysql_user","required":false,"schema":{"example":"username","type":"string"}},{"description":"The MySQL server's password.","in":"query","name":"mysql_pass","required":false,"schema":{"example":"12345luggage","type":"string"}},{"description":"The MySQL server's port.","in":"query","name":"mysql_port","required":false,"schema":{"example":3306,"maximum":65535,"minimum":1,"type":"integer"}},{"description":"A description of the profile data.","in":"query","name":"setup_via","required":false,"schema":{"example":"Main terminal","maxLength":255,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"profile_details":{"description":"An object containing the updated profile's data.","properties":{"active":{"description":"Whether the system uses this profile to access the MySQL server.\n* `1` — Active.\n* `0` — Not active.","enum":[0,1],"example":0,"type":"integer"},"mysql_host":{"description":"The MySQL server's IP address or hostname.","example":"192.168.0.1","oneOf":[{"format":"ipv4","type":"string"},{"format":"hostname","type":"string"}]},"mysql_pass":{"description":"The MySQL server's password.","example":"12345luggage","type":"string"},"mysql_port":{"description":"The MySQL server's port.","example":3306,"maximum":65535,"minimum":1,"type":"integer"},"mysql_user":{"description":"The MySQL server's username.","example":"username","type":"string"},"setup_via":{"description":"A description of the profile data.","example":"Main terminal","maxLength":255,"type":"string"}},"type":"object"},"profile_saved":{"description":"The updated profile's name.","example":"MyProfile","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"remote_mysql_update_profile","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update remote MySQL profile","tags":["Databases","Remote MySQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n remote_mysql_update_profile \\\n name='MyProfile'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_update_profile?api.version=1&name=MyProfile"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/remote_mysql_validate_profile":{"get":{"description":"This function validates a specified remote MySQL® profile's connection details.","operationId":"remote_mysql_validate_profile","parameters":[{"description":"The profile's name.","in":"query","name":"name","required":true,"schema":{"example":"MyProfile","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"profile_validated":{"description":"The validated profile's name.","example":"MyProfile","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"remote_mysql_validate_profile","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate remote MySQL profile connection","tags":["Databases","Remote MySQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n remote_mysql_validate_profile \\\n name='MyProfile'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_validate_profile?api.version=1&name=MyProfile"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/remote_mysql_read_profiles":{"get":{"description":"This function displays the details of all remote MySQL® profiles available in WHM.","operationId":"remote_mysql_read_profiles","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"example":{"MyProfile":{"active":0,"is_localhost_profile":1,"mysql_host":"192.168.0.1","mysql_pass":"123456luggage","mysql_port":3306,"mysql_user":"username","mysql_version_is_supported":0,"setup_via":"Main terminal"},"MyProfile2":{"active":0,"is_localhost_profile":"1","mysql_host":"192.168.0.2","mysql_pass":"123456luggage","mysql_port":3306,"mysql_user":"username","mysql_version_is_supported":"0","setup_via":"Main terminal"},"localhost":{"active":1,"is_localhost_profile":1,"mysql_host":"localhost","mysql_pass":"#1mpll-C","mysql_port":3306,"mysql_user":"root","mysql_version_is_supported":0,"setup_via":"Auto-Migrated active profile"}},"properties":{"additionalProperties":{"description":"An object containing the MySQL profile's data.\n\n**Note:**\n\nThe profile's name is the return's name.","properties":{"active":{"description":"Whether the system uses this profile to access the MySQL server.\n\n* `1` — Accesses the MySQL server.\n* `0` — Does **not** access the MySQL server.","enum":[1,0],"example":0,"type":"integer"},"is_localhost_profile":{"description":"Whether the system's MySQL profile functions with the server's\nlocal MySQL instance.\n\n**Note:**\n\n* `1` — Functions with the local MySQL instance.\n* `0` — Does **not** function with the local MySQL instance.","enum":[1,0],"example":1,"type":"integer"},"mysql_host":{"description":"The MySQL server's IP address or hostname.","oneOf":[{"description":"A valid hostname.","example":"hostname.example.com","format":"hostname","type":"string"},{"description":"A valid IP address.","example":"192.168.0.1","type":"string"}]},"mysql_pass":{"description":"The MySQL server's password.","example":"123456luggage","type":"string"},"mysql_port":{"description":"The MySQL server's port.","example":3306,"maximum":65535,"minimum":1,"type":"integer"},"mysql_user":{"description":"The MySQL server's username.","example":"username","format":"username","type":"string"},"mysql_version_is_supported":{"description":"Whether the system supports the server's MySQL version.\n\n* `1` — Supported.\n* `0` — **Not** supported.","enum":[1,0],"example":0,"type":"integer"},"setup_via":{"description":"A description of the MySQL profile data.","example":"Main terminal","maxLength":255,"type":"string"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"remote_mysql_read_profiles","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return remote MySQL profiles","tags":["Databases","Remote MySQL Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n remote_mysql_read_profiles\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_mysql_read_profiles?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.52"}},"/accesshash":{"get":{"deprecated":true,"description":"This function regenerates or retrieves a user's access hash. For more information about access hashes, read our [Remote Access Key](https://docs.cpanel.net/whm/clusters/remote-access-key/) documentation.\n\n**Warning:**\n\nWe **deprecated** this function. We **strongly** suggest that you use the WHM API 1 `api_token_create` function.","operationId":"accesshash","parameters":[{"description":"The user's name.","in":"query","name":"user","required":true,"schema":{"example":"root","format":"username","type":"string"}},{"description":"Whether to regenerate the access hash.\n* `1` — Regenerate the access hash.\n* `0` — Do **not** regenerate the access hash.","in":"query","name":"generate","required":true,"schema":{"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"accesshash":{"description":"The user's access hash.","example":"cb523f89e9a31123fde7c6f93b580ac05bf00a2804d4febe6667ab9917a14baa1c4914da209bf55c862999ea51983a117a4d2f238140200b1e5b270b94b2c52492747e5ebfdeddb8abf4e1b0c428c6c68b701b48e13dbe39da49450e7a8e5422e18ab3b6290b5b6556bd82ee21d9c1103e7a51d1e94f2ac0c4dcc6a10954b8634c6db16a541660c3c89e10254f05583f4167adfcff7781090ea930647b46e5b981f3e16c7723ca4e12dc4b54a778dc66a28df73632a0d3a8e01e207b9fd6b555b72936a903af014f30061d712d736176a87fb5333c5b90cf0bb4f3c6735f2b45929ac79fb1184045a5f4c20bfcc553f5ab760eec077c0d6096e54d02724201281e441e7b0f642370a63f61c68766e224c8510bc32b0316780660c34352cbfeeccfee9d4f02e20ba7b664d3e84e9419ca386c41df07613f8af252aba8626a8b54796bbe616f41af1e6f11a3d0327f7608d23666fca64e6ebe899f7479a5fb0aea008b1e7a41890c9c58037682450febf91b7aa1c080d31d834b0ae466f8533df838ab271b26a7fb7de96402ad4a818d6b786af92c38414d2ef6c88deb7c685a1e60c3cbcfbf20cf6d2a00dd50d2be9bc1824d91284ec6842dd7db42564dfc3ecb75c1a9bc775c45c5f08784b9e2885c2d","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"accesshash","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account access hash","tags":["SSH Keys and Connections"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n accesshash \\\n user='root' \\\n generate='0'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/accesshash?api.version=1&user=root&generate=0"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/acctcounts":{"get":{"description":"This function lists a reseller's total accounts, suspended accounts, and account creation limit.","operationId":"acctcounts","parameters":[{"description":"A reseller's username, to query that reseller. If you do not specify a value, the function lists information for the authenticated account.","in":"query","name":"user","required":false,"schema":{"example":"username","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"reseller":{"description":"An object that contains information for an account.","properties":{"active":{"description":"The number of active accounts that the reseller account owns.","example":9,"minimum":1,"type":"integer"},"limit":{"description":"The maximum number of accounts that the reseller account may create, if a maximum exists.\n\n**NOTE:**\n\nA null value indicates that the reseller does not have an account creation limit.","example":25,"minimum":1,"nullable":true,"type":"integer"},"suspended":{"description":"The number of suspended accounts that the reseller account owns.","example":5,"minimum":1,"nullable":true,"type":"integer"},"user":{"description":"The reseller account's username or the `root` user.","example":"root","type":"string"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"acctcounts","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return reseller's owned accounts' information","tags":["Resellers","Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n acctcounts\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/acctcounts?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/get_remote_access_hash":{"get":{"deprecated":true,"description":"This function retrieves a hash from a remote access file.\n\n**Warning:**\n\nWe deprecated this function. We **strongly** suggest that you use the WHM API 1 `api_token_list` function.","operationId":"get_remote_access_hash","parameters":[{"description":"The user's username.","in":"query","name":"username","required":true,"schema":{"example":"user","type":"string"}},{"description":"Whether to generate a new hash for the user, if one does not exist.\n\n* `1` — Generate a new hash.\n* `0` — Do **not** generate a new hash.","in":"query","name":"generate","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The user's password.","in":"query","name":"password","required":true,"schema":{"example":"123456luggage","type":"string"}},{"description":"The server's hostname.","in":"query","name":"host","required":true,"schema":{"example":"hostname.example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"accesshash":{"description":"The account's remote access hash.","example":"6b355856c00606648b803a7d896186632472d584eaf0dad878b8885e1f64edad24b31ff79f2675303a598ac211ad5188c589fb60c5786a3e8d85c2029ca4ea76edb62becff7e3f7c5421f51bb4896737c22eda761e2a6fd96404bf513ee9051480ea86c800ab9b45f5255590836c7b769816a8f7f5def1e0c6cb19c212f01f56bb3392854ce51178a943eab6d1ce5d44857e980f70724f50964d2fbe01cb076a119dc5bf421051c2a0882550cdc69872832167c91e11bbe5c95d98474096ebe14b6ca9da2d73faecea5ec37f208912f5da578d5f8ab7c257584002e1808614f9859dceae564e8f30a9790c232d005ebd44f912e20b72e731fc600156e5b9f2902b0dd913010022e6b0deb6a2fb0d38ff3fd005c53f321ec812d3be10643dce81c46e1b9e2abe8814d46ba49b8a173b3e01ec677ea182cabb55db6d9eab2240755be1bbb1d7094a155fd262934ec099fdba3b10f409dced62d3d570ab6478a269a95da1314a45a5916da07312bf7e5a53d57b090e9c24932776f7ffdcf90ba2fa5cd935995795348b67311185f54da6b90da8771585e78c5f587e427bead9198faaa631b8216099c25373c8d4c26a011f295188963840777d09d95b6385df8337098b7e231534323457b9388fe9ea8046","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"get_remote_access_hash","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return remote access file's hash","tags":["Server Administration","API Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n get_remote_access_hash \\\n username='user' \\\n password='123456luggage' \\\n host='hostname.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/get_remote_access_hash?api.version=1&username=user&password=123456luggage&host=hostname.example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/listresellers":{"get":{"description":"This function lists the reseller accounts on the server.","operationId":"listresellers","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"reseller":{"description":"An array of the server's reseller accounts.","items":{"example":"bob","type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"listresellers","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all resellers","tags":["Resellers","Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n listresellers\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/listresellers?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/getresellerips":{"get":{"description":"This function lists a reseller's available IP addresses.","operationId":"getresellerips","parameters":[{"description":"A reseller's username, to query only that reseller.\n\n**Note:**\n\nIf you do **not** specify a value, the function lists available IP addresses for the `root`\nuser.","in":"query","name":"user","required":false,"schema":{"example":"username","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"all":{"description":"Whether all of the reseller's IP addresses are available.\n* `1` — All of the reseller's IP addresses are available.\n* `0` — Some or all IP addresses are unavailable.","enum":[0,1],"example":1,"type":"integer"},"ip":{"description":"The reseller's available IP addresses.","items":{"example":"192.168.0.20","format":"ipv4","type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"getresellerips","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return reseller's available IP addresses","tags":["Resellers","Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n getresellerips\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/getresellerips?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/resellerstats":{"get":{"description":"This function lists data about a reseller's accounts.","operationId":"resellerstats","parameters":[{"description":"The reseller's username.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"Do not display the reseller's deleted cPanel accounts in the function's `acct` return. This parameter modifies the data output in the `acct` return.\n\n* `1` — Do **not** display.\n* `0` — Display.","in":"query","name":"filter_deleted","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Do not display the reseller's suspended cPanel accounts in the function's `acct` return. This parameter modifies the data output in the `acct` return.\n\n* `1` — Do **not** display.\n* `0` — Display.","in":"query","name":"filter_suspended","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"The month to query, in numeric format.\n\nThis parameter defaults to the current month.","in":"query","name":"month","required":false,"schema":{"example":2,"maximum":12,"minimum":1,"type":"integer"}},{"description":"The year to query, in numeric format.\n\nThis parameter defaults to the current year.","in":"query","name":"year","required":false,"schema":{"example":2019,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"reseller":{"description":"Object containing data about a reseller account.","properties":{"acct":{"description":"Array of objects that contains data about all of the reseller's accounts.\n\n**Note:**\n\nThis array also returns the reseller account.","items":{"properties":{"bandwidthlimit":{"description":"The account's bandwidth limit.\n\n* A positive numeric value, encoded as a string, that represents the account's bandwidth limit, in megabytes (MB).\n* `0.00` — The account has unlimited bandwidth.","example":"500","type":"string"},"bandwidthused":{"description":"The account's current bandwidth use.\nA positive numeric value, encoded as a string, that represents the account's bandwidth use, in megabytes (MB).","example":0,"type":"string"},"deleted":{"description":"Whether the account has been deleted.\n\n* `1` — Deleted.\n* `0` — **Not** deleted.","enum":[0,1],"example":0,"type":"integer"},"diskquota":{"description":"The account's disk space quota.\n\n* A positive numeric value, encoded as a string, that represents the account's disk space quota, in megabytes (MB).\n* `0.00` — The account has unlimited disk space.","example":"1100.00","type":"string"},"diskused":{"description":"The account's current disk space use.\nA positive numeric value, encoded as a string, that represents the account's current disk space use, in megabytes (MB).","example":"1.57","type":"string"},"domain":{"description":"The account's main domain.","example":"example1.com","format":"domain","type":"string"},"package":{"description":"The account's hosting plan (package).","example":"default","type":"string"},"suspended":{"description":"Whether the account is suspended.\n\n* `1` — Suspended.\n* `0` — Not suspended.","enum":[0,1],"example":0,"type":"integer"},"user":{"description":"The account's username.","example":"example1","format":"username","type":"string"}},"type":"object"},"type":"array"},"bandwidthlimit":{"description":"The reseller's total bandwidth limit.\n\n* A positive integer that represents the reseller's bandwidth limit, in megabytes (MB).\n* `0` — The reseller has unlimited bandwidth.","example":0,"minimum":0,"type":"integer"},"bwoverselling":{"description":"Whether the reseller can oversell bandwidth.\n\n* `1` — The reseller can oversell bandwidth.\n* `0` — The reseller **cannot** oversell bandwidth.","enum":[0,1],"example":0,"type":"integer"},"diskoverselling":{"description":"Whether the reseller can oversell disk space.\n\n* `1` — The reseller can oversell disk space.\n* `0` — The reseller **cannot** oversell disk space.","enum":[0,1],"example":0,"type":"integer"},"diskquota":{"description":"The reseller's total disk space quota.\n\n* A positive integer that represents the reseller's disk space quota, in megabytes (MB).\n* `0` — The reseller has unlimited disk space.","example":0,"minimum":0,"type":"integer"},"diskused":{"description":"The total amount of disk space that the reseller and all of its accounts use, in megabytes (MB).\n\n**Note:**\n\nThis value does not include disk space the reseller account uses if the root account owns it.","example":5.69,"type":"number"},"month":{"description":"The current month or a queried month.","example":2,"maximum":12,"minimum":1,"type":"integer"},"totalbwalloc":{"description":"The total amount of bandwidth that the reseller has given to its accounts, in megabytes (MB), encoded as a string.","example":"500","type":"string"},"totalbwused":{"description":"The total amount of bandwidth that the reseller's accounts have used, in megabytes (MB), encoded as a string.","example":0,"type":"string"},"totaldiskalloc":{"description":"The total amount of disk space that the reseller has given to its accounts, in megabytes (MB), encoded as a string.","example":"1100","type":"string"},"user":{"description":"The reseller account's username.","example":"username","format":"username","type":"string"},"year":{"description":"The current year or a queried year.","example":2019,"type":"integer"}},"type":"object"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"resellerstats","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return reseller's information","tags":["Resellers","Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n resellerstats \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/resellerstats?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/setresellerips":{"get":{"description":"This function adds IP addresses to a reseller's account.\n\n**Note:**\n\nTo assign a main IP address to a reseller's account, call the WHM API 1 `setresellermainip` function.\n\nFor more information, read our [Manage Reseller's IP Delegation](https://go.cpanel.net/whmdocsManageResellersIPDelegation) documentation.","operationId":"setresellerips","parameters":[{"description":"The reseller's username.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The IP addresses to allocate to the reseller's account.\n\n**Note:**\n\n* If you do **not** use this parameter, the function clears the reseller's IP address list.\n* Use a comma-separated list to allocate multiple IP addresses.","in":"query","name":"ips","required":false,"schema":{"example":"192.168.0.20","format":"ipv4","type":"string"}},{"description":"Whether to allocate the reseller a dedicated IP address.\n\n* `1` — Restrict the reseller's account to its dedicated IP address.\n* `0` — Allow the user to dedicate any available IP address to an owned account.","in":"query","name":"delegate","required":false,"schema":{"default":0,"enum":[1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"all":{"description":"Whether the function allocated all available IP addresses to the reseller. This return **only** appears if you set the `delegate` parameter to `0`.\n\n**Note:**\n\n`1` is the only possible value.","enum":[1],"example":1,"type":"integer"},"ip":{"description":"An array of the reseller's allocated IP addresses.","items":{"example":"192.168.0.20","format":"ipv4","type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"setresellerips","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add IP addresses to reseller","tags":["Resellers","Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n setresellerips \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/setresellerips?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/setacls":{"get":{"description":"This function creates or modifies an Access Control List (ACL).\n\n**Note:**\n\n For each `acl-*` parameter, any value adds that privilege to the ACL list and no value removes that privilege from the ACL list.\n\n**Warning:**\n\n We **strongly** recommend that WHM users create and edit ACLs and ACL privileges through WHM's [*Edit Reseller Nameservers and Privileges*](https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges) interface ( *WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges* ).","operationId":"setacls","parameters":[{"description":"The reseller's username.","in":"query","name":"reseller","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The ACL to assign to the reseller.\n\n**Warning:**\n\n Functions should **either** use this parameter, or a combination of the `acl-*` parameters below. **Do not** include both in a single function.","in":"query","name":"acllist","required":false,"schema":{"example":"my_acl_list","type":"string"}},{"description":"Whether to allow the reseller to edit hosting plans (packages).","in":"query","name":"acl-edit-pkg","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to add and remove hosting plans (packages).","in":"query","name":"acl-add-pkg","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to view existing hosting plans (packages).","in":"query","name":"acl-list-pkgs","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to troubleshoot mail delivery.","in":"query","name":"acl-mailcheck","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to generate a mobile configuration profile for an email account.","in":"query","name":"acl-generate-email-config","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to view account bandwidth usage.","in":"query","name":"acl-show-bandwidth","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to view the list of accounts.","in":"query","name":"acl-list-accts","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to view an account summary.","in":"query","name":"acl-acct-summary","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to use DNS clusters.","in":"query","name":"acl-clustering","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to modify the server's news.","in":"query","name":"acl-news","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to manage third-party services.","in":"query","name":"acl-thirdparty","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to remove DNS zones.","in":"query","name":"acl-kill-dns","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to edit DNS zones.","in":"query","name":"acl-edit-dns","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to execute cPanel API 1, cPanel API 2 and UAPI functions via WHM.","in":"query","name":"acl-cpanel-api","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to park DNS zones.","in":"query","name":"acl-park-dns","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to add DNS zones.","in":"query","name":"acl-create-dns","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to manage API tokens.\n\n**Note:**\n\n This privilege allows an API token user to bypass any restrictions that you set on the API token. For more information, read our [Manage API Tokens](https://go.cpanel.net/whmdocsManageasisAPITokens) documentation.","in":"query","name":"acl-manage-api-tokens","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to manage external authentication for their accounts.","in":"query","name":"acl-manage-oidc","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to manage DNS records.","in":"query","name":"acl-manage-dns-records","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to manage their server's cPanel styles.","in":"query","name":"acl-manage-styles","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to manage nameservers.","in":"query","name":"acl-nameserver-config","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to perform SSL site management.","in":"query","name":"acl-ssl","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to view their server's SSL information.","in":"query","name":"acl-ssl-info","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to retrieve MySQL® database and user data.","in":"query","name":"acl-mysql-info","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to create accounts.","in":"query","name":"acl-create-acct","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to suspend or unsuspend accounts.","in":"query","name":"acl-suspend-acct","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to retrieve basic system information.","in":"query","name":"acl-basic-system-info","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to access basic cPanel & WHM options.","in":"query","name":"acl-basic-whm-functions","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to change passwords.\n\n**Note:**\n\n This privilege allows an API token user to change account passwords and log in with a new password. For more information, read our [Manage API Tokens](https://go.cpanel.net/whmdocsManageasisAPITokens) documentation.","in":"query","name":"acl-passwd","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to purchase SSL certificates.","in":"query","name":"acl-ssl-buy","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to manage how their server and its services connect to other servers and services.","in":"query","name":"acl-cpanel-integration","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to perform Cross-Origin Resource Sharing (CORS) HTTP requests.","in":"query","name":"acl-cors-proxy-get","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to upgrade or downgrade accounts.","in":"query","name":"acl-upgrade-account","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to generate SSL certificates.","in":"query","name":"acl-ssl-gencrt","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to create a temporary session user for a specified service.\n\n**Note:**\n\n This privilege allows an API token user to bypass any restrictions that you set on the API token. For more information, read our [Manage API Tokens](https://go.cpanel.net/whmdocsManageasisAPITokens) documentation.","in":"query","name":"acl-create-user-session","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to edit MX entries.","in":"query","name":"acl-edit-mx","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to manage Digest Authentication support.","in":"query","name":"acl-digest-auth","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to terminate accounts.","in":"query","name":"acl-kill-acct","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to use all global packages. For more information, read our [reseller packages](https://go.cpanel.net/resellerpackages) documentation.","in":"query","name":"acl-viewglobalpackages","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to create accounts with shell access.","in":"query","name":"acl-disallow-shell","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to create packages with shell access.","in":"query","name":"acl-add-pkg-shell","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to create packages with addon domains.","in":"query","name":"acl-allow-addoncreate","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to create packages with parked domains (aliases).","in":"query","name":"acl-allow-parkedcreate","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to create packages with unlimited disk space.","in":"query","name":"acl-allow-unlimited-disk-pkgs","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to create packages with unlimited features.","in":"query","name":"acl-allow-unlimited-pkgs","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to create packages with unlimited bandwidth.","in":"query","name":"acl-allow-unlimited-bw-pkgs","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to create packages with a dedicated IP address.","in":"query","name":"acl-add-pkg-ip","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to create and modify locales on the server.","in":"query","name":"acl-locale-edit","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to resync FTP passwords.","in":"query","name":"acl-resftp","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to restart services.","in":"query","name":"acl-restart","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to view the server's status.","in":"query","name":"acl-status","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to view server information.","in":"query","name":"acl-stats","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to modify quotas.\n\n**Warning:**\n\n If you do **not** use resource limits, a value of `1` allows resellers to circumvent package limits for disk space.","in":"query","name":"acl-quota","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to enable demo mode for accounts.","in":"query","name":"acl-demo-setup","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to edit accounts.","in":"query","name":"acl-edit-account","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to modify bandwidth limits (quotas).\n\n**Warning:**\n\n If you do **not** use resource limits, a value of `1` allows resellers to circumvent package limits for disk space.","in":"query","name":"acl-limit-bandwidth","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to rearrange accounts.","in":"query","name":"acl-rearrange-accts","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to allow the reseller to view reports about email message delivery attempts from their account.","in":"query","name":"acl-track-email","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}},{"description":"Whether to grant the reseller all ACL privileges.\n\n**Warning:**\n\n A value of `1` grants `root`-level privileges to the reseller.","in":"query","name":"acl-all","required":false,"schema":{"enum":[1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"acl":{"description":"An array of the reseller's privileges. An array that contains the names of one or more privileges.","items":{"example":"all","type":"string"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"setacls","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success\n* `0` - Failed: Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create or update reseller privilege settings","tags":["Resellers","Account Permissions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty setacls reseller='username' acl-acct-summary=1 acl-basic-system-info=1 acl-basic-whm-functions=1 acl-cors-proxy-get=1 acl-cpanel-api=1 acl-cpanel-integration=1 acl-create-user-session=1 acl-digest-auth=1 acl-generate-email-config=1 acl-list-pkgs=1 acl-manage-api-tokens=1 acl-manage-dns-records=1 acl-manage-oidc=1 acl-manage-styles=1 acl-mysql-info=1 acl-ns-config=1 acl-public-contact=1 acl-ssl-info=1 acl-track-email=1"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/setacls?api.version=1&reseller=username&acl-acct-summary=1&acl-basic-system-info=1&acl-basic-whm-functions=1&acl-cors-proxy-get=1&acl-cpanel-api=1&acl-cpanel-integration=1&acl-create-user-session=1&acl-digest-auth=1&acl-generate-email-config=1&acl-list-pkgs=1&acl-manage-api-tokens=1&acl-manage-dns-records=1&acl-manage-oidc=1&acl-manage-styles=1&acl-mysql-info=1&acl-ns-config=1&acl-public-contact=1&acl-ssl-info=1&acl-track-email=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/removeacct":{"get":{"description":"This function deletes a cPanel or WHM account.","operationId":"removeacct","parameters":[{"description":"The account's username.","in":"query","name":"username","required":true,"schema":{"example":"username","type":"string"}},{"deprecated":true,"description":"The account's username.","in":"query","name":"user","schema":{"example":"username","type":"string"}},{"description":"Whether to retain the account's DNS entries.\n- `1` — Retain DNS entries.\n- `0` — Delete DNS entries.","in":"query","name":"keepdns","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"removeacct","type":"string"},"output":{"properties":{"raw":{"description":"The function's raw output.","example":"\"raw\":\"Running pre removal script (/usr/local/cpanel/scripts/prekillacct)......Done\\nCollecting Domain Name and IP...User: example\\nDomain: example.com\\n...Done\\nLocking account and setting shell to nologin...Locking password for user example.\\npasswd: Success\\n...Done\\nKilling all processes owned by user......Done\\nRemoving Sessions.........Done\\nRemoving Suspended Info.........Done\\nCleaning Virtfs.........Done\\nRemoving Web Logs......Done\\nRemoving Bandwidth Files......Done\\nRemoving Email Sending Limits Cache......Done\\nRemoving DKIM keys......Done\\nRemoving Crontab......Done\\nRemoving HTTP Virtual Hosts...Removed the following non-SSL virtual hosts: example.com\\nRemoved the following SSL virtual hosts:\\n...Done\\nRemoving ftp Virtual Hosts......Done\\nRemoving user's web content directory symlinks......Done\\nRemoving MySQL databases and users......Done\\nRemoving PostgreSQL databases and users......Done\\nRemoving User & Group.......Success...Done\\nRemoving DNS Entries...example.com => deleted from hostname. \\n...Done\\nRemoving Email Setup...Removing /etc/valiases/example.com\\n...Done\\nRemoving mailman lists......Done\\nUpdating Databases......Done\\nRemoving bandwidth limits......Done\\nRemoving Counter Data......Done\\nAdding IP back to the IP address pool...System has 2 free ips.\\n...Done\\nRemoving user's cPanel Databases & Updating......Done\\nReloading Services......Done\\nRemoving mail and service configs...\\n...Done\\nSending Contacts......Done\\nUpdating internal databases...Updating ftp passwords for example\\nPurging ftp user example\\nFtp password files updated.\\nFtp vhost passwords synced\\n...Done\\nRunning post removal scripts (/usr/local/cpanel/scripts/legacypostkillacct, /usr/local/cpanel/scripts/postkillacct)......Done\\nAccount Removal Complete!!!...example account removed...Done\\n\"","type":"string"}},"type":"object"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"example account removed","type":"string"},"result":{"description":"- `1` — Success\n- `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete cPanel account","tags":["Account Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n removeacct \\\n username='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/removeacct?api.version=1&username=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/setresellermainip":{"get":{"description":"This function assigns a main IP address to a reseller's account.\n\n**Note:**\n\n To assign additional IP addresses to a reseller's account, call the WHM API 1 `setresellerips` function.","operationId":"setresellermainip","parameters":[{"description":"The reseller's username.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}},{"description":"The IP address to assign to the reseller's account as the main shared IP address.","in":"query","name":"ip","required":true,"schema":{"example":"192.168.0.20","format":"ipv4","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"setresellermainip","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update reseller's main IP address","tags":["Resellers","Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n setresellermainip \\\n user='username' \\\n ip='192.168.0.20'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/setresellermainip?api.version=1&user=username&ip=192.168.0.20"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/setupreseller":{"get":{"description":"This function grants reseller status to an account.\n\n**Note:**\n\nThis function grants reseller status to an **existing** account. You **cannot** create a new account with this function.","operationId":"setupreseller","parameters":[{"description":"The account's username.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"Whether to set the account to own itself.\n* `1` — Make the account own itself.\n* `0` — Keep the account's current owner.","in":"query","name":"makeowner","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"setupreseller","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable cPanel account's reseller status","tags":["Resellers","Reseller Account Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n setupreseller \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/setupreseller?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/setresellernameservers":{"get":{"description":"This function assigns nameservers to a reseller's account.","operationId":"setresellernameservers","parameters":[{"description":"The reseller's username.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"A comma-separated list of the nameserver domains to assign to the reseller's account.\n\n**Note:**\n\nIf you do **not** use this parameter, the function resets the reseller's nameservers\nto use the server default.","examples":{"multiple":{"summary":"Multiple nameservers","value":"ns1.example.com,ns2.example.com"},"single":{"summary":"A single nameserver","value":"ns1.example.com"}},"in":"query","name":"nameservers","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"setresellernameservers","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update reseller's assigned nameservers","tags":["Resellers","Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n setresellernameservers \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/setresellernameservers?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/suspendreseller":{"get":{"description":"This function suspends a reseller account.","operationId":"suspendreseller","parameters":[{"description":"The reseller's username.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The reason for the reseller's suspension.\n\n**Note:**\n\n We **strongly** recommend that you **always** include a reason for suspension.","in":"query","name":"reason","required":false,"schema":{"example":"Nonpayment","type":"string"}},{"description":"Whether to suspend only the reseller account.\n* `1` — The function **only** suspends the reseller account. The function will **not** suspend the accounts that the reseller account owns.\n* `0` — The function suspends the reseller account **and** the accounts that it owns.","in":"query","name":"reseller-only","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to allow only the `root` user to unsuspend the account.\n* `1` — **Only** the `root` user can unsuspend the account.\n* `0` — The `root` user or the account's owner can unsuspend the account.","in":"query","name":"disallow","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"suspendreseller","type":"string"},"output":{"properties":{"raw":{"description":"The raw output from the function.","type":"string"}},"type":"object"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Suspend reseller","tags":["Resellers","Reseller Account Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n suspendreseller \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/suspendreseller?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/setresellerpackagelimit":{"get":{"description":"This function limits the packages that a reseller assigns to cPanel accounts.","operationId":"setresellerpackagelimit","parameters":[{"description":"The reseller's username.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"Whether to grant the reseller unlimited package use.\n* `1` — Grant the reseller unlimited package use.\n* `0` — Use package limits.","in":"query","name":"no_limit","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"A hosting plan (package), to modify the reseller's access settings for it.\n\n**Note:**\n\n Use this parameter with the `number` or `allowed` parameters.","in":"query","name":"package","required":false,"schema":{"example":"package1","type":"string"}},{"description":"Whether the reseller can access the package hosting plan.\n* `1` — Enable access.\n* `0` — Disable access\n\n**Note:**\n\nIf you use this parameter, you **must** also include the `package` parameter.","in":"query","name":"allowed","required":false,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"The maximum number of accounts to which the reseller can assign the package hosting plan.\n\n**Note:**\n\n* If you use this parameter, you **must** also include the `package` parameter.\n* If you set a value for this parameter **and** set the `allowed` parameter to `0`, the reseller **cannot** use the hosting plan.","in":"query","name":"number","required":false,"schema":{"example":5,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"setresellerpackagelimit","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update reseller's hosting plan limits","tags":["Resellers","Account Limits"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n setresellerpackagelimit \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/setresellerpackagelimit?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/unsetupreseller":{"get":{"description":"This function revokes reseller status from an account.","operationId":"unsetupreseller","parameters":[{"description":"The reseller account's username.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"unsetupreseller","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disables cPanel account's reseller status","tags":["Resellers","Reseller Account Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n unsetupreseller \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/unsetupreseller?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/authorizesshkey":{"get":{"description":"This function authorizes a public SSH key to access the server.\nWhen you call this function, it adds the key to the `/root/.ssh/authorized_keys` file.\n\n**Warning:**\n\n* Do **not** transfer private keys over insecure ports.\n* Only `root` and `root`-enabled resellers can use this function, and it only affects\nthe `root` public SSH keys. To perform this function on a regular user account, call\nthe cPanel API 2 `SSH::authkey` function via the WHM API. For more information, read our\n[Use WHM API to Call cPanel API and UAPI](https://go.cpanel.net/UseWHMAPItoCallcPanelAPIandUAPI)\ndocumentation.","operationId":"authorizesshkey","parameters":[{"description":"The public SSH key file's name.\n\n**Note:**\n\n* This file **must** exist in the `/root/.ssh` directory.\n* If you call **both** the `file` and the `text` parameters, the function **ignores**\nthe `file` parameter.","in":"query","name":"file","required":true,"schema":{"example":"sshkey.pub","type":"string"}},{"description":"The text of the SSH public key file.\n\n**Note:**\n\n* If you call **both** the `file` and the `text` parameters, the function **ignores**\nthe `file` parameter.","in":"query","name":"text","required":true,"schema":{"example":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCys7JbGhkAZ8E4Pmq8D4EBm1UedKK2oMhs3RVIEFRJX6S86Itw6Qmhds62LNGrxuVL11W6v25+maIiBhXnslyQpd838tHyAC7J/SJojDid8acovX/4xgJQaJHLAh9tLgyQXnNhIxIGJ4nVZ+8OqM2Vb1Cps+E5H17ivG07PXnVPEvwMaeWkm2DnGgSy5kmjVpNKlj9GWFCn/SJd7up7QnbGKoz87pxKDs3esp+ziuPEAJHLeXnKHWPVukQgtRUpUBdqkCvu5hUkhpaiWmBR8yxajkxbSObPw+ZkELhmm+fQseOfEbrwToMRJCO7gAKwBtNi7OhyFM7YFrvdo0xh6cn","type":"string"}},{"description":"Whether to authorize the public SSH key to access the server.\n\n* `1` — Authorize.\n* `0` — Do **not** authorize.","in":"query","name":"authorize","required":true,"schema":{"enum":[1,0],"example":1,"type":"integer"}},{"description":"A comma-separated list of options to include with the public SSH key.\nFor a list of options, read the\n[OpenBSD manaual](https://man.openbsd.org/sshd.8#AUTHORIZED_KEYS_FILE_FORMAT).\n\nThis parameter defaults to no options.","in":"query","name":"options","required":false,"schema":{"example":"agent-forwarding,cert-authority","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"authorized":{"description":"Whether the public SSH key has authorization.\n* `1` — Authorized.\n* `0` — **Not** authorized.","enum":[1,0],"example":1,"type":"integer"},"file":{"description":"The public SSH key file's name.","example":"sshkey.pub","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"authorizesshkey","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable SSH key for server","tags":["SSH Keys and Connections"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n authorizesshkey \\\n file='sshkey.pub' \\\n text='ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCys7JbGhkAZ8E4Pmq8D4EBm1UedKK2oMhs3RVIEFRJX6S86Itw6Qmhds62LNGrxuVL11W6v25+maIiBhXnslyQpd838tHyAC7J/SJojDid8acovX/4xgJQaJHLAh9tLgyQXnNhIxIGJ4nVZ+8OqM2Vb1Cps+E5H17ivG07PXnVPEvwMaeWkm2DnGgSy5kmjVpNKlj9GWFCn/SJd7up7QnbGKoz87pxKDs3esp+ziuPEAJHLeXnKHWPVukQgtRUpUBdqkCvu5hUkhpaiWmBR8yxajkxbSObPw+ZkELhmm+fQseOfEbrwToMRJCO7gAKwBtNi7OhyFM7YFrvdo0xh6cn' \\\n authorize='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/authorizesshkey?api.version=1&file=sshkey.pub&text=ssh-rsa%20AAAAB3NzaC1yc2EAAAADAQABAAABAQCys7JbGhkAZ8E4Pmq8D4EBm1UedKK2oMhs3RVIEFRJX6S86Itw6Qmhds62LNGrxuVL11W6v25%2bmaIiBhXnslyQpd838tHyAC7J%2fSJojDid8acovX%2f4xgJQaJHLAh9tLgyQXnNhIxIGJ4nVZ%2b8OqM2Vb1Cps%2bE5H17ivG07PXnVPEvwMaeWkm2DnGgSy5kmjVpNKlj9GWFCn%2fSJd7up7QnbGKoz87pxKDs3esp%2bziuPEAJHLeXnKHWPVukQgtRUpUBdqkCvu5hUkhpaiWmBR8yxajkxbSObPw%2bZkELhmm%2bfQseOfEbrwToMRJCO7gAKwBtNi7OhyFM7YFrvdo0xh6cn&authorize=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/terminatereseller":{"get":{"description":"This function deletes a reseller and **all** of the reseller's cPanel accounts.\n\n**Warning:**\n\n* You **cannot** recover deleted accounts. **Use this function with extreme caution.**\n* This function deletes the reseller account and **all** of the accounts that the reseller\nowns.\n* To remove reseller privileges from an account but **not** delete the reseller's account\nor any accounts that the reseller owns, use the WHM API 1 `unsetupreseller` function.","operationId":"terminatereseller","parameters":[{"description":"The reseller account's username.","in":"query","name":"user","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"Whether to terminate the reseller's main account.\n\n* `1` — Terminate.\n* `0` — Do **not** terminate.","in":"query","name":"terminatereseller","required":true,"schema":{"enum":[1,0],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"acct":{"description":"An array of objects containing the function's output.","items":{"properties":{"output":{"description":"An object containing the termination data for the reseller's accounts.","properties":{"raw":{"description":"Output from the account's removal.\n\n**Note:**\n\nThis output may contain HTML.","example":"Running pre removal script (/usr/local/cpanel/scripts/prekillacct)......DoneCollecting\nDomain Name and IP...User: example Domain: example.com\n...DoneLocking account and setting shell to nologin...Locking\npassword for user example. passwd: Success ...DoneKilling\nall processes owned by user......DoneRemoving\nSessions.........DoneRemoving Suspended Info.........DoneCleaning\nVirtfs.........DoneRemoving Web Logs......DoneRemoving\nBandwidth Files......DoneRemoving Email Sending\nLimits Cache......DoneRemoving DKIM keys......DoneRemoving\nCrontab......DoneRemoving HTTP Virtual Hosts...Removed\nthe following non-SSL virtual hosts: example.com\nRemoved the following SSL virtual hosts: ...DoneRemoving\nftp Virtual Hosts......Done Removing user''''s\nweb content directory symlinks......DoneRemoving\nMySQL databases and users......DoneRemoving PostgreSQL\ndatabases and users......DoneRemoving User & Group.......Success...Done\nRemoving DNS Entries...example.com => deleted\nfrom hostname. ...Done Removing Email Setup...Removing\n/etc/valiases/example.com ...Done Removing mailman\nlists......Done Updating Databases......Done Removing\nbandwidth limits......Done Removing Counter Data......Done\nAdding IP back to the IP address pool...System\nhas 3 free ips. ...Done Removing user''''s cPanel\nDatabases & Updating......Done Reloading Services......Done\nRemoving mail and service configs... ...Done Removing\nLogaholic Webstats...Id: TQ:TaskQueue:129 ...Done\nSending Contacts......Done Updating internal databases...Updating\nftp passwords for example Purging ftp user example\nFtp password files updated. Ftp vhost passwords\nsynced ...Done Running post removal scripts (/usr/local/cpanel/scripts/legacypostkillacct,\n/usr/local/cpanel/scripts/postkillacct)......Done\nAccount Removal Complete!!!...example account\nremoved...Done\n","type":"string"}},"type":"object"},"reason":{"description":"A message of success or the reason for a failure.","example":"username account removed","type":"string"},"result":{"description":"Whether the function succeeded.\n\n* `1` — Success.\n* `0` — Failure.","enum":[1,0],"example":1,"type":"integer"},"user":{"description":"The account username.","example":"username","format":"username","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"terminatereseller","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete reseller and reseller's cPanel accounts","tags":["Resellers","Reseller Account Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n terminatereseller \\\n user='username' \\\n terminatereseller='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/terminatereseller?api.version=1&user=username&terminatereseller=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/unsuspendreseller":{"get":{"description":"This function unsuspends a reseller account.","operationId":"unsuspendreseller","parameters":[{"description":"The reseller's username.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}},{"description":"Whether to unsuspend only the reseller account.\n* `1` — The function **only** unsuspends the reseller account. The function will **not** unsuspend the accounts that the reseller account owns.\n* `0` — The function unsuspends the reseller account **and** the accounts that it owns.","in":"query","name":"reseller-only","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"unsuspendreseller","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Unsuspend reseller","tags":["Resellers","Reseller Account Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n unsuspendreseller \\\n user='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/unsuspendreseller?api.version=1&user=username"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/generatesshkeypair":{"get":{"description":"This function generates an SSH key pair.","operationId":"generatesshkeypair","parameters":[{"description":"The key's secure passphrase.","in":"query","name":"passphrase","required":false,"schema":{"default":"","example":"123456luggage","type":"string"}},{"description":"The key's filename.\n\nThis parameter defaults to `id_rsa` if the algorithm is RSA, and `id_dsa`\nif the algorithm is DSA.","in":"query","name":"name","required":false,"schema":{"default":"id_rsa","example":"KeyFile","type":"string"}},{"description":"The key's bits:\n\n* `1024` — The DSA algorithm's default value.\n* `2048`\n* `4096` — The RSA algorithm's default value.","in":"query","name":"bits","required":false,"schema":{"enum":[1024,2048,4096],"example":2048,"type":"integer"}},{"description":"The key's encryption algorithm. The parameter defaults to the system's default algorithm.","in":"query","name":"algorithm","required":false,"schema":{"enum":["rsa2","dsa"],"example":"dsa","type":"string"}},{"description":"Whether to abort the function if the user already has a key with the same name.\n\n* `1` — Abort.\n* `0` — Continue.","in":"query","name":"abort_on_existing_key","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"A comment.","in":"query","name":"comment","required":false,"schema":{"default":"","example":"NoComment","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"fingerprint":{"description":"The key's [MD5](https://en.wikipedia.org/wiki/MD5) fingerprint.","example":null,"format":"md5","nullable":true,"type":"string"},"name":{"description":"The key's filename.","example":"KeyFile","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"generatesshkeypair","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create SSH key pair","tags":["SSH Keys and Connections"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n generatesshkeypair\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/generatesshkeypair?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.32"}},"/check_remote_ssh_connection":{"get":{"description":"This function tests an SSH connection to another server.","operationId":"check_remote_ssh_connection","parameters":[{"description":"The remote server's hostname.","in":"query","name":"host","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The remote server's port number.","in":"query","name":"port","required":false,"schema":{"default":22,"example":22,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"comment":{"description":"The remote connection's comment section.\n* A valid string.\n* `undef` - If the local and remote servers connect successfully.","example":"null","type":"string"},"protocol_versions":{"description":"The available SSH protocol versions.\n* A valid string.\n* `undef` - If the local and remote servers connect successfully.","items":{"example":"2.0","type":"string"},"type":"array"},"received":{"description":"The raw data from the remote server.","example":"SSH-2.0-OpenSSH_5.3","type":"string"},"server_software":{"description":"The version of the remote server's SSH server software.\n* A valid string.\n* `undef` - If the local and remote servers connect successfully.","example":"OpenSSH_5.3","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"check_remote_ssh_connection","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate SSH connection to another server","tags":["SSH Keys and Connections"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n check_remote_ssh_connection \\\n host='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/check_remote_ssh_connection?api.version=1&host=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/convertopensshtoputty":{"get":{"description":"This function converts an OpenSSH private key to a PuTTY key.\n\n**Warning:**\n\nDo **not** transfer private keys over insecure ports.","operationId":"convertopensshtoputty","parameters":[{"description":"The private key file's name.","in":"query","name":"file","required":true,"schema":{"example":"KeyFile","type":"string"}},{"description":"The private key file's passphrase.","in":"query","name":"passphrase","required":false,"schema":{"default":"","example":"12345luggage","type":"string"}},{"description":"Whether to keep the OpenSSH file on the server after conversion.\n* `1` — Keep the file.\n* `0` — Delete the file.","in":"query","name":"keep_file","required":false,"schema":{"default":1,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"key":{"description":"The converted key file's text.","example":"PuTTY-User-Key-File-2: ssh-rsa Encryption: aes256-cbc Comment: imported-openssh-key Public-Lines: 12 AAAAB3NzaC1yc2EAAAABIwAAAgEAuuth41YYyWABsRKexJXgSMD8FvIBFCptUfZP 4U/6R41FvL/RS+99kq1WL/KASsKRoEA5uc0axM+iNgZtKuemQYGUZNvN+8X8sC/l E6GF7X3Pvj2Ml4AlD7TQv0WQZUp9xn+SlOti+3pYh+S56vzNjvdifO7U5mPGW/81 9N4vGhG3ThaAgETwkL33CM2LeNRuvoWpeQcuzEVX2aOvHQZqOvV15fTjZ64ZGL3i UDtKmeaHs4tMqgNIUXgn1P1V4TgPvTIfopH8FBX3g1pD15XD3vn+XHLwia0505c5 +QM+jElS3HHb0vrrDo3S+8koXLWp07wu/GYrvBd5+MlsSV7bpr7lmWj8uMQjc0ap eZe+eb/MteadWnqIPeOVuracssCvDLqXEPK2KjhFMPqBTepNhZaJHRfvkodPm43C 50nhqzrNoxFvXb1rfCjPPqGfhuSZhlCmo2FDiZPKdl0X7bhzDIvMVikyqJP06bqK y9iclyQv0VPfyCIx/VDcVclIoUa8A49nAinXHKeUx9QUNBHv8wXdyz7W41jQa+++ Ih3Yc4o9rpV95DDmKp7iF6kFk4aVjIWDgEsPTaL28wlvUyazoW5TAGPHDrRJoedU ag8KDRNPrGbKYu3CvoINiz0sshyCvr1gjKNG75Cwe+L4hXIkaw8wlCpwFq8VSX70 RS9Pei8= Private-Lines: 28 bb31s+xsiAv1+pclnmvreEYdxvuVmbeWMjUWJd4Y4TKIAyLEItsXNs078qn1QAZ+ Wj6t+0HcnhuUVICHyCyJrp++1g4OtzTAHRczaD5ybhb9ktSe1qlnszKD1Rg5/o+B 61h6kvMcZyuNSjtPkmqQ3XIh8OFYybB2oJXY7gJQzfRuRwk8dx9YWtIR4438Nbv5 ecTzGUDWvx+AfYzC4X/UIGiRy8AftfiBQyA+c1OFyg37qM1SLYnZYmIpSf5GsQ3A MaEGlB9P9hE2uoqZ4yT/A0aHj7w8DGEzYZqxNbMlCIJhLEO3vKZvMvaq7Q8ramG6 BzYwUz+8NPgCBUp1qyIcN2vvEHEq57pMMHYNfJMVfG9o0ijo+xxGCPV3MosmmvRI 1nxH0nrgdA2o6SJp/dJrKm3Hicbbxak/Kz4m8BROcnlCgptdjHp9V/cBnFq/UUHv or32gShGWmnG6+XyQs4LxpbLC4koz8EjPwg3/3W2Qn6Drn3i98omvZpmnX466i7e GUiHaiKTpBkqZkHmHFxNBAbbs85yngeo8o3RGUsmN69RupTqSkkLDuDFOMwgfsZG TWexWg/qBe+8Xrbshd9HphxvWv+Q3YcSeg+mm8Bc50Q5saLKYdQQsbfV5wtIpvLj 0eyjoTSh+FkPGBw/iB1MDzYV5OoIIgiDBndP2bOK2zFsLElSbbv/r3i//wL98316DgJWmJiQDqKxly4MEij8TfIVDAsdeyJJKvg6iGahonHbEBkZ9g9wcCpxlg8iMtTf /7eb8SmcPwe1NGdgB7PR1dU/RQ/kBbLaaBfo/1jQEnCC8VmksVu7B9ULImfLEOEm +A4J4NpKKlQocgCvJAtMogL+uRS5GpojJIElVqP12jnb7Ij3AYY3Zb4qotlprLeK 7dJslpNnrD/MSvbJZ/ZoAX+xyDxUMeq/83Xv30i5/wh00QBY4Cv5NTDU4rPoVmQm EWGW5aQx34in4JHY5bK3F4BvVYm7MscKLHoU8/OeKVAgzNcatUgPlN43FG9SX0AE pP3EYlVADSfULdbfBn9dZDidAiDMXnCv9259J65zA64tuT9XluinHXVs5PA/f5vm rZPQhAzGThw7h9L6rGYGfSKd9KYoTwf8kSOA6WU7OEyhfTvCdaW76vPi4CRW2M/Y RHX0IUdv3VxfKb4WnXFeQl6LshmGB1T2mbMyfThlqUCGAvPJyWDtZ6OpOUl3CK87 3jhFzO7t5wruhuWZ3RcISVsrdqcjgCrKy6Q9y+HbLJoNY40BkJm7f6WeV+hHn7o1 od7JiqDGq3Qk+ECEdexvqdRQS7BWgO7xudGFk+WFY02zoGvq5DMviNfsxqhM06P+ JgEinB8xPPCOPzi6q8T1y1Pz44gmluM15/QRX4z0Mwz6UQasVC/NsZxdfoNGtCy0 c2DAscy4zsiKhZMlLr0loPYycO2bOit6E5eYkrACJR2115/ZgVwzvzdmc/INJCxG3TvKYbeuv/tkolt56uJWGfMF2ZrfLJaaQ0iAiUyMep/keLP2bJ4Y97o+03BtQszZ zixXvzeQAX97WdBaUJU0C3mCKDOtkv4RWZ8hXV5v0m2tm7xbXVBzF22Pej2iHDKx GQkciskBRwQM4bDZorkcO+WnGn6uPbtw5v/AuIUqB1UNAcehWN6UTiFNveP4hLYu iRGWnZZ+uTbip91PNXSxXzb9yMWV2qSVIsZvud8kpR8ttL26Z4ySUKkFuPrgUeTeELnOF3GP6Ixk+IkwxU575w== Private-MAC: 1dfa6a4c8297d31e4cfadbf61aac8b4c5ca75584","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"convertopensshtoputty","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Migrate OpenSSH key to PuTTY format","tags":["SSH Keys and Connections"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n convertopensshtoputty \\\n file='KeyFile'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/convertopensshtoputty?api.version=1&file=KeyFile"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.32"}},"/setresolvers":{"get":{"description":"This function configures the server's resolver nameservers.\n\n**Warning:**\n\n* The nameservers that the server uses as resolvers **must** function correctly. If they do not, the server will experience performance and stability issues.\n* **Never** set a resolver nameserver to `127.0.0.1` on a cPanel & WHM server.","operationId":"setresolvers","parameters":[{"description":"The server's primary resolver nameserver.","in":"query","name":"nameserver1","required":true,"schema":{"example":"192.168.0.20","oneOf":[{"format":"ipv4","type":"string"},{"format":"ipv6","type":"string"}]}},{"description":"The server's secondary resolver nameserver.","in":"query","name":"nameserver2","required":true,"schema":{"example":"192.168.0.21","format":"ipv4","oneOf":[{"format":"ipv4","type":"string"},{"format":"ipv6","type":"string"}]}},{"description":"The server's tertiary resolver nameserver.","in":"query","name":"nameserver3","required":false,"schema":{"default":"","example":"2001:4860:4860::8888","oneOf":[{"format":"ipv4","type":"string"},{"format":"ipv6","type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"setresolvers","type":"string"},"output":{"description":"Messages returned from the call.","properties":{"messages":{"example":"Listed in order they are:\n192.168.0.20\n192.168.0.21\n2001:4860:4860::8888\n","type":"string"}},"type":"object"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Your resolvers have been setup!","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update server's resolver nameservers","tags":["DNS","Resolvers"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n setresolvers \\\n nameserver1='192.168.0.20' \\\n nameserver2='192.168.0.21'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/setresolvers?api.version=1&nameserver1=192.168.0.20&nameserver2=192.168.0.21"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/importsshkey":{"get":{"description":"This function imports an SSH key.","operationId":"importsshkey","parameters":[{"deprecated":true,"description":"The key's owner.\n\n**Note:**\n\nYou can specify this parameter, but the system does **not** use it.","in":"query","name":"user","required":false,"schema":{"example":"username","format":"username","type":"string"}},{"description":"The key's name.","in":"query","name":"name","required":true,"schema":{"example":"TestKey","type":"string"}},{"description":"The key's contents.","in":"query","name":"key","required":true,"schema":{"example":"-----BEGIN RSA PRIVATE KEY----- hPH+o4NgZrky7iGBb5iUg8R4aQzLPexpYfet25bLESvHOtutsBkbN7UWAaoM0pgM hytunlM8UU4BArJWlJyY6AD59aluZowBbuowKeU+f+TRaeJNJvkxTCOAipzp6LyG nrSVJ5hxSN/RPfntho1MEsdWYewVI4eLayuiZJyD+VONCYJh/vPLaZ9AVUJuMerl s/ZJ24AwCW8cILG+C3TWJRCjl4Ji+sJ9A5P29p/ad18cyJc1F+wmAzMULWitCaB7 mmE0i1nkiZRygQzzKjqdBYWCjujxfoE2+nPufAJg8ZdIEI1xSVBe5jKnj8DRX67w NAnNjXANMRePo39/RbDOSEXsD62h1qH93SnPsAhYT1JE6xHKV85AVIVOe8ktTA8t jMBBioCudBFngqPHknUrIJZ2QfUm0fkKBZaoKW4yr3JjGk+5y6kg02gSDIA7/jGc 8rs3iKN+QJ/ug2x/v7Xe0OozVqpl5QTltEMGJzJ1jFh9WnqgsgLTiJWlE7x5VSv8 fV8A5WTafOhBHnKuOpmpjAel1GD5DT1jNx3LhWXMHOayawC0WY04lT5kkLLWhuN2 pNqY6UBk6Z3m1ifPINq85RdnHriJiD3H/+6P+cUyGSOznni8yqU764LId4nNClWd Xc+VvM1Udw0Sm7xF7err9CKHYUg3HfFYQPBQOfI0ib9wqOi7zWq2vhH21B5OgcTg Bsw/HJUQ/IVnTbsqgZSn0sckaRguv/ifmwbISO1aQ4Yxcohe/4miOw05r6ihbYGW LO5kP0I8SBMCibkGFh5AxVnNgoGAW0l33hOPPSIVUTkE+8d3zYXLzupTFXCvmohl jq0it7uIGOxSglf7XH3eXlNKaZjK7pBJgS5HeXM80JI8FCfifqnkaik8XTE66Ll0 s1ySaGevGkPpX5Rhbgsm4IqddAeFvlmKIND8Zvh/wfT++bbD7bbFwFlrWCU3chce 8KaNVUP+whCAlaS7oGcs38ygaRFXIE3vug4Ra8Xiy/qfyp4YR67sMg46avHyoVky uFbVv2n7HphZb7g3WS3ns3/gCQQv9TYcdBoRnKW2yEqbzOQb9Fdt7EjgMohT/bdS pM6nRWFNdmWoihLzLbSi3bnc9iDwXZA8KyE3mpVi4QFfijR4dfrVWxEz5Ln2l9HC SZA6VPGzEOwOVVND98/HTu3oViJUV1gyDIWlyggSUDTyhfo/Z+c3tTHa+cv0f7xY oL63hWLgZQD2m/g6rKpsN3NhC77tCyCNZavdKy7usvZyCsoH/mPR2129LcwAwbJ3 u2Ec7qLncztSePHOmfmCTTED00a0YzFhKIQoJf7GrgLCMapYN/YPu0vgTDMPSi11 RH0rdyzd6MuPVDZwLnWO+SltjX85yz1ba/Q199HZwQOw6ZyejDaPSWJHOndD3k+r Q0T38gci9k4D87EwmfpK7zOaCoaiGiRQ6+DdYOv6hlzQ6Fdb2FOtlGQZharQ9WTC jOJBEj2oGUruc6P3fqhfUVllWi4cck0GgWZwcsmG1dDr8W6K9lrGA1dPbXoOns1B l58ghMGtHG7D0VlHs6SIqFmHr5kUgSQ4jJ2KZkVU8CrPBZ2HRtHQJJyjZWW2AbrE -----END RSA PRIVATE KEY-----","type":"string"}},{"description":"Whether to extract and save only the public key.\n* `1` — Public key only.\n* `0` — All data.\n\n**Note:**\n\nThis parameter defaults to `1` for\nPPK [(PuTTY Key Generator)](https://www.puttygen.com/)\nfiles and `0` for all other imports.","in":"query","name":"extract_public","required":false,"schema":{"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to extract and save only the private key.\n* `1` — Private key only.\n* `0` — All data.\n\n**Note:**\n\nThis parameter defaults to `1` for\nPPK [(PuTTY Key Generator)](https://www.puttygen.com/)\nfiles and `0` for all other imports.","in":"query","name":"extract_private","required":false,"schema":{"enum":[0,1],"example":0,"type":"integer"}},{"description":"The key's passphrase.\n\n**Note:**\n\nThis parameter is **required** whenever you import a PPK file.","in":"query","name":"passphrase","required":false,"schema":{"default":null,"example":"123456luggage","nullable":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"importsshkey","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Import SSH key","tags":["SSH Keys and Connections"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n importsshkey \\\n name='TestKey' \\\n key='-----BEGIN RSA PRIVATE KEY----- hPH+o4NgZrky7iGBb5iUg8R4aQzLPexpYfet25bLESvHOtutsBkbN7UWAaoM0pgM hytunlM8UU4BArJWlJyY6AD59aluZowBbuowKeU+f+TRaeJNJvkxTCOAipzp6LyG nrSVJ5hxSN/RPfntho1MEsdWYewVI4eLayuiZJyD+VONCYJh/vPLaZ9AVUJuMerl s/ZJ24AwCW8cILG+C3TWJRCjl4Ji+sJ9A5P29p/ad18cyJc1F+wmAzMULWitCaB7 mmE0i1nkiZRygQzzKjqdBYWCjujxfoE2+nPufAJg8ZdIEI1xSVBe5jKnj8DRX67w NAnNjXANMRePo39/RbDOSEXsD62h1qH93SnPsAhYT1JE6xHKV85AVIVOe8ktTA8t jMBBioCudBFngqPHknUrIJZ2QfUm0fkKBZaoKW4yr3JjGk+5y6kg02gSDIA7/jGc 8rs3iKN+QJ/ug2x/v7Xe0OozVqpl5QTltEMGJzJ1jFh9WnqgsgLTiJWlE7x5VSv8 fV8A5WTafOhBHnKuOpmpjAel1GD5DT1jNx3LhWXMHOayawC0WY04lT5kkLLWhuN2 pNqY6UBk6Z3m1ifPINq85RdnHriJiD3H/+6P+cUyGSOznni8yqU764LId4nNClWd Xc+VvM1Udw0Sm7xF7err9CKHYUg3HfFYQPBQOfI0ib9wqOi7zWq2vhH21B5OgcTg Bsw/HJUQ/IVnTbsqgZSn0sckaRguv/ifmwbISO1aQ4Yxcohe/4miOw05r6ihbYGW LO5kP0I8SBMCibkGFh5AxVnNgoGAW0l33hOPPSIVUTkE+8d3zYXLzupTFXCvmohl jq0it7uIGOxSglf7XH3eXlNKaZjK7pBJgS5HeXM80JI8FCfifqnkaik8XTE66Ll0 s1ySaGevGkPpX5Rhbgsm4IqddAeFvlmKIND8Zvh/wfT++bbD7bbFwFlrWCU3chce 8KaNVUP+whCAlaS7oGcs38ygaRFXIE3vug4Ra8Xiy/qfyp4YR67sMg46avHyoVky uFbVv2n7HphZb7g3WS3ns3/gCQQv9TYcdBoRnKW2yEqbzOQb9Fdt7EjgMohT/bdS pM6nRWFNdmWoihLzLbSi3bnc9iDwXZA8KyE3mpVi4QFfijR4dfrVWxEz5Ln2l9HC SZA6VPGzEOwOVVND98/HTu3oViJUV1gyDIWlyggSUDTyhfo/Z+c3tTHa+cv0f7xY oL63hWLgZQD2m/g6rKpsN3NhC77tCyCNZavdKy7usvZyCsoH/mPR2129LcwAwbJ3 u2Ec7qLncztSePHOmfmCTTED00a0YzFhKIQoJf7GrgLCMapYN/YPu0vgTDMPSi11 RH0rdyzd6MuPVDZwLnWO+SltjX85yz1ba/Q199HZwQOw6ZyejDaPSWJHOndD3k+r Q0T38gci9k4D87EwmfpK7zOaCoaiGiRQ6+DdYOv6hlzQ6Fdb2FOtlGQZharQ9WTC jOJBEj2oGUruc6P3fqhfUVllWi4cck0GgWZwcsmG1dDr8W6K9lrGA1dPbXoOns1B l58ghMGtHG7D0VlHs6SIqFmHr5kUgSQ4jJ2KZkVU8CrPBZ2HRtHQJJyjZWW2AbrE -----END RSA PRIVATE KEY-----'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/importsshkey?api.version=1&name=TestKey&key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%20hPH%2bo4NgZrky7iGBb5iUg8R4aQzLPexpYfet25bLESvHOtutsBkbN7UWAaoM0pgM%20hytunlM8UU4BArJWlJyY6AD59aluZowBbuowKeU%2bf%2bTRaeJNJvkxTCOAipzp6LyG%20nrSVJ5hxSN%2fRPfntho1MEsdWYewVI4eLayuiZJyD%2bVONCYJh%2fvPLaZ9AVUJuMerl%20s%2fZJ24AwCW8cILG%2bC3TWJRCjl4Ji%2bsJ9A5P29p%2fad18cyJc1F%2bwmAzMULWitCaB7%20mmE0i1nkiZRygQzzKjqdBYWCjujxfoE2%2bnPufAJg8ZdIEI1xSVBe5jKnj8DRX67w%20NAnNjXANMRePo39%2fRbDOSEXsD62h1qH93SnPsAhYT1JE6xHKV85AVIVOe8ktTA8t%20jMBBioCudBFngqPHknUrIJZ2QfUm0fkKBZaoKW4yr3JjGk%2b5y6kg02gSDIA7%2fjGc%208rs3iKN%2bQJ%2fug2x%2fv7Xe0OozVqpl5QTltEMGJzJ1jFh9WnqgsgLTiJWlE7x5VSv8%20fV8A5WTafOhBHnKuOpmpjAel1GD5DT1jNx3LhWXMHOayawC0WY04lT5kkLLWhuN2%20pNqY6UBk6Z3m1ifPINq85RdnHriJiD3H%2f%2b6P%2bcUyGSOznni8yqU764LId4nNClWd%20Xc%2bVvM1Udw0Sm7xF7err9CKHYUg3HfFYQPBQOfI0ib9wqOi7zWq2vhH21B5OgcTg%20Bsw%2fHJUQ%2fIVnTbsqgZSn0sckaRguv%2fifmwbISO1aQ4Yxcohe%2f4miOw05r6ihbYGW%20LO5kP0I8SBMCibkGFh5AxVnNgoGAW0l33hOPPSIVUTkE%2b8d3zYXLzupTFXCvmohl%20jq0it7uIGOxSglf7XH3eXlNKaZjK7pBJgS5HeXM80JI8FCfifqnkaik8XTE66Ll0%20s1ySaGevGkPpX5Rhbgsm4IqddAeFvlmKIND8Zvh%2fwfT%2b%2bbbD7bbFwFlrWCU3chce%208KaNVUP%2bwhCAlaS7oGcs38ygaRFXIE3vug4Ra8Xiy%2fqfyp4YR67sMg46avHyoVky%20uFbVv2n7HphZb7g3WS3ns3%2fgCQQv9TYcdBoRnKW2yEqbzOQb9Fdt7EjgMohT%2fbdS%20pM6nRWFNdmWoihLzLbSi3bnc9iDwXZA8KyE3mpVi4QFfijR4dfrVWxEz5Ln2l9HC%20SZA6VPGzEOwOVVND98%2fHTu3oViJUV1gyDIWlyggSUDTyhfo%2fZ%2bc3tTHa%2bcv0f7xY%20oL63hWLgZQD2m%2fg6rKpsN3NhC77tCyCNZavdKy7usvZyCsoH%2fmPR2129LcwAwbJ3%20u2Ec7qLncztSePHOmfmCTTED00a0YzFhKIQoJf7GrgLCMapYN%2fYPu0vgTDMPSi11%20RH0rdyzd6MuPVDZwLnWO%2bSltjX85yz1ba%2fQ199HZwQOw6ZyejDaPSWJHOndD3k%2br%20Q0T38gci9k4D87EwmfpK7zOaCoaiGiRQ6%2bDdYOv6hlzQ6Fdb2FOtlGQZharQ9WTC%20jOJBEj2oGUruc6P3fqhfUVllWi4cck0GgWZwcsmG1dDr8W6K9lrGA1dPbXoOns1B%20l58ghMGtHG7D0VlHs6SIqFmHr5kUgSQ4jJ2KZkVU8CrPBZ2HRtHQJJyjZWW2AbrE%20-----END%20RSA%20PRIVATE%20KEY-----"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/listsshkeys":{"get":{"description":"This function lists the server's SSH keys.\n\n**Warning:**\n\nOnly the `root` account can use this function, and it only affects the `root`\nkeys. To perform this function on a regular user account, call the cPanel API\n2 `SSH::listkeys` function through the WHM API.","operationId":"listsshkeys","parameters":[{"description":"A filename, to limit the results to keys that have that filename.","in":"query","name":"files","required":false,"schema":{"example":"TestKey","type":"string"}},{"description":"Whether to display only public keys.\n\n* `1` — Display only public keys.\n* `0` — Display all keys.","in":"query","name":"public","required":false,"schema":{"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to display only private keys.\n\n* `1` — Display only private keys.\n* `0` — Display all keys.","in":"query","name":"private","required":false,"schema":{"default":1,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to include public key text.\n\n* `1` — Include public key text.\n* `0` — Do **not** include public key text.","in":"query","name":"public_texts","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to include private key text.\n\n* `1` — Include private key text.\n* `0` — Do **not** include private key text.","in":"query","name":"private_texts","required":false,"schema":{"default":1,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to synchronize the keys that can access the server.\n\n* `1` — Synchronize the keys.\n* `0` — Do **not** synchronize the keys.","in":"query","name":"sync_authorized","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"keys":{"description":"An array of objects of each key's information.","items":{"properties":{"authorized":{"description":"Whether the key is authorized to access the server.\n\n* `1` — Authorized.\n* `0` — **Not** authorized.","enum":[0,1],"example":0,"type":"integer"},"comment":{"description":"The key's comment.","example":"REPO username@example.com","type":"string"},"ctime":{"description":"The date that the key was created, in\n[Unix time format](http://en.wikipedia.org/wiki/Unix_time).","example":1416596824,"format":"unix_timestamp","type":"integer"},"file":{"description":"The key's filename.","example":"TestKey","type":"string"},"mtime":{"description":"The date that the key will expire, in Unix time format.","example":1416596824,"format":"unix_timestamp","type":"integer"},"private":{"description":"Whether the private key is stored on the server.\n\n* `1` — The private key is on the server.\n* `0` — The private key is **not** on the server.","enum":[0,1],"example":1,"type":"integer"},"text":{"description":"The key's text.","example":"ssh-rsaXXXXX3XXXX1XX2XXXXXXXXXXXXXXxXXXX6XXXXX90X41X7XXXXX02XXXXX8XXXX54XXXXXXXXXXX2X07XXXXXXXXXXX7XXXX4XXX2X98XXXX98X80XXXXXXX7X/X4XXXXxX1XXXXXXXXXXXxXXXXXXXXX6+4XXXX36XXXXX3XXXXXX1XXXXXXX/X7+XX1XX6XXXX0XXXXXXX0XXXXXXXX+XxX99X7X2XXXXXX03xXXXXX0XXXXXXXXXX9XXXXXXX9XXXXXXXXXXXX/XXXXX07XXXXX3XXXXXX5XXX+/XXXXXXXXXXXXX3XxXXXXXXXXXXXX6XXXXXXXXXXXX2XXXXXXXXXXXXXXXXX3XX+XXXX3XXXXXXX== REPO username@example.com","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"listsshkeys","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return SSH keys list","tags":["SSH Keys and Connections"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n listsshkeys\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/listsshkeys?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/deletesshkey":{"get":{"description":"This function function deletes an SSH key from the server.\n\n**Warning:**\n\nOnly the `root` account can use this function, and it only affects\nthe `root` keys. To perform this function on a cPanel user account, call the\ncPanel API 2 `SSH::authkey` function through the WHM API.","operationId":"deletesshkey","parameters":[{"description":"The SSH key's username.","in":"query","name":"user","required":false,"schema":{"deprecated":true,"example":"username","type":"string"}},{"description":"The SSH key file's name.","in":"query","name":"file","required":true,"schema":{"example":"/root/.ssh/test","type":"string"}},{"description":"Whether to authorize the SSH key to access the server.\n\n* `1` — Leave authorized.\n* `0` — Do **not** leave authorized.","in":"query","name":"leave_authorized","required":false,"schema":{"default":1,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"file":{"description":"The SSH key file's name.","example":"/root/.ssh/test","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"deletesshkey","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete SSH key","tags":["SSH Keys and Connections"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n deletesshkey \\\n file='/root/.ssh/test'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/deletesshkey?api.version=1&file=%2froot%2f.ssh%2ftest"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11"}},"/fetch_ssl_vhosts":{"get":{"description":"This function lists the server's virtual hosts (vhosts) and their installed SSL certificates.","operationId":"fetch_ssl_vhosts","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"vhosts":{"description":"An array of objects containing virtual host information.","items":{"properties":{"crt":{"description":"Information about the certificate.","properties":{"created":{"description":"The date the certificate was created.","example":1538308800,"format":"unix_timestamp","type":"integer"},"domains":{"description":"A list of the certificate's associated domains.","example":["example.com","subdomain.example.com"],"items":{"format":"domain","type":"string"},"type":"array"},"ecdsa_curve_name":{"description":"The ECDSA curve that the certificate's key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The certificate's key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The certificate's key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"encryption_algorithm":{"description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"id":{"description":"The certificate's ID.","example":"example1_com_e353a_5bc13_1408033388_9a1d40aff655f98fed7206e5af466065","type":"string"},"is_self_signed":{"description":"Whether the certificate is self-signed.\n\n* `1` — Self-signed.\n* `0` — Not self-signed.","enum":[1,0],"example":1,"type":"integer"},"issuer.commonName":{"description":"The certificate's issuer.","example":"example.com","type":"string"},"issuer.organizationName":{"description":"The certificate's Organization Name.","example":"Organization","type":"string"},"issuer_text":{"description":"The full text of issuer information.","example":"commonName\nsubdomain.example.com","type":"string"},"modulus":{"description":"The certificate's key's modulus, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an RSA key.","example":"e353aa25cc8ad05d3225611e4410c0270c11b2d46f88705d3d179a23102ab24ee167c1a9070b9f554e83bade1b84256e11c5a0cb2ac96b96f28e802b11c721d73fbfe61dd9839974a6fce4e17915c0fbf885056f18656041cf70db460b22cab5fd2502491e4ab9f0d2cb727480e0ebd62e83870acda31bfa2d4625efd82234f9729f351ea02fb162609c1654c11b5dec468539a3bb83073a85f78bcf577cd8b718501145cccd89d7adb0bb18c872e7303a15e2c75a6ab315c7fa099e4351a4f0ff126c2693f71d9f21d9f798b94bb689277083fea8dcc01b6af268d0ad8b7a481f8a179d07639cdf3290c93723937a767c400a8ce4b1ca19f0a7117084d5bc13","nullable":true,"type":"string"},"modulus_length":{"description":"The certificate's key's modulus length.\n\n* `null` — The certificate's key is **not** an RSA key.","example":2048,"nullable":true,"type":"integer"},"not_after":{"description":"The date the certificate expires.","example":1601467200,"format":"unix_timestamp","type":"integer"},"not_before":{"description":"The date the certificate became active.","example":1569844800,"format":"unix_timestamp","type":"integer"},"public_exponent":{"description":"The certificate's exponent.","example":"010001","type":"string"},"signature_algorithm":{"description":"The certificate's OID hash algorithm.","example":"sha256WithRSAEncryption","type":"string"},"subject.commonName":{"description":"An object containing the certificate's Common Name.","properties":{"commonName":{"description":"The certificate's Common Name.","example":"example.com","type":"string"}},"type":"object"},"subject_text":{"description":"The certificate's subject text.","example":"commonName\nsubdomain.example.com","type":"string"},"validation_type":{"description":"The certificate's validation type.\n\n* `dv` — Domain validation.\n* `ev` — Extended validation.\n* `ov` — Organizational validation.\n* `null` — Self-signed certificate.","enum":["dv","ev","ov"],"example":"dv","nullable":true,"type":"string"}},"type":"object"},"docroot":{"description":"The absolute directory path of the primary domain's document root.","example":"/home/example/public_html","format":"path","type":"string"},"domains":{"description":"A list of the virtual host's domains.","example":["example.com"],"items":{"format":"domain","type":"string"},"type":"array"},"ip":{"description":"The virtual host's IP address.","example":"192.168.0.20","format":"ipv4","type":"string"},"iptype":{"description":"The type of IP address.\n\n* `shared`\n* `dedicated`","enum":["shared","dedicated"],"example":"dedicated","type":"string"},"ipv6":{"description":"The virtual host's IPv6 address.","example":"2001:0db8:0:0:1:0:0:1","format":"ipv6","type":"string"},"is_primary_on_ip":{"description":"Whether the certificate's domain is the IP address's primary domain.\n\n* `1` — Primary domain.\n* `0` — **Not** the primary domain.","enum":[1,0],"example":1,"type":"integer"},"mail_sni_status":{"description":"Whether SNI for mail is enabled.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[1,0],"example":1,"type":"integer"},"needs_sni":{"description":"Whether the virtual host requires SNI to function properly for\nSSL certificates.\n\n* `1` — Requires SNI.\n* `0` — Does **not** require SNI.","enum":[1,0],"example":0,"type":"integer"},"servername":{"description":"The virtual host's primary domain.","example":"example.com","format":"domain","type":"string"},"type":{"description":"The virtual host's domain type.\n\n* `addon` — Addon domain.\n* `main` — Main domain on account.\n* `parked` — Parked domain.\n* `sub` — Subomain.","enum":["addon","main","parked","sub"],"example":"sub","type":"string"},"user":{"description":"The virtual host's username.","example":"example","format":"username","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"fetch_ssl_vhosts","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return server vhosts and SSL certificates","tags":["SSL","cPanel Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n fetch_ssl_vhosts\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/fetch_ssl_vhosts?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.32"}},"/add_autossl_user_excluded_domains":{"get":{"description":"This function disables AutoSSL for an account's specified domains.","operationId":"add_autossl_user_excluded_domains","parameters":[{"description":"The cPanel user's account.","in":"query","name":"username","required":true,"schema":{"example":"example","format":"username","type":"string"}},{"description":"Disable AutoSSL for this domain.\n\n**Note:**\n\nTo disable AutoSSL for multiple domains, increment the parameter name. For example, `domain=example.com`, `domain-1=example1.com`, and `domain-2=example.com`.","examples":{"multiple":{"description":"Disable AutoSSL for multiple domains.","value":["example.com","example1.com","example2.com"]},"single":{"description":"Disable AutoSSL for a single domain.","value":["example.com"]}},"explode":true,"in":"query","name":"domain","required":true,"schema":{"items":{"format":"domain","type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"add_autossl_user_excluded_domains","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable AutoSSL for domain","tags":["SSL","Auto-Generated Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n add_autossl_user_excluded_domains \\\n username='example' \\\n domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/add_autossl_user_excluded_domains?api.version=1&username=example&domain=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"66"}},"/disable_autossl":{"get":{"description":"This function disables the AutoSSL feature.","operationId":"disable_autossl","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"disable_autossl","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the reason field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable AutoSSL","tags":["SSL","Auto-Generated Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n disable_autossl\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/disable_autossl?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"58"}},"/save_spamd_config":{"get":{"description":"This function configures your Apache SpamAssassin™ options.\n\n**Important:**\n\nWhen you disable the [Spam Filter role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system disables this function.","operationId":"save_spamd_config","parameters":[{"description":"A comma-separated list of IP addresses to authorize to access the spamd daemon.\n\n**Note:**\n\n* If you do **not** specify a value, the `spamd` daemon allows connections from any IP address.\n* If you set a value for this parameter, it **must** include `127.0.0.1` in the list of values so that the `chkservd` daemon can access the `spamd` daemon.","explode":false,"in":"query","name":"allowedips","required":false,"schema":{"example":"127.0.0.1,192.168.0.1","type":"string"},"style":"form"},{"description":"The maximum number of connections that the `spamd` daemon allows per child process.","in":"query","name":"maxconnperchild","required":false,"schema":{"example":200,"minimum":1,"type":"integer"}},{"description":"The maximum number of children per `spamd` process.","in":"query","name":"maxchildren","required":false,"schema":{"example":5,"minimum":1,"type":"integer"}},{"description":"The process ID's file path.\n\n**Warning:**\n\nThis parameter changes the `spamd` daemon's process ID filepath. On\nsystems that use the `systemd` daemon, you must update the `PIDFile`\nparameter in the `spamd.service` definition. If you do not update the\n`PIDFile` parameter, the `spamd` daemon will fail to function because the\nPID path and the `PIDFile` parameter will not match.","in":"query","name":"pidfile","required":false,"schema":{"example":"/var/run/spamd.pid","type":"string"}},{"description":"The maximum amount of time that the `spamd` daemon waits before it abandons a TCP connection.\n\n**Note:**\n\nIf the value of this parameter is `0`, `spamd` will **not** abandon TCP connections.","in":"query","name":"timeouttcp","required":false,"schema":{"example":30,"minimum":0,"type":"integer"}},{"description":"The maximum amount of time that a child process waits before it abandons a TCP connection.\n\n**Note:**\n\nIf the value of this parameter is `0`, child processes will **not** abandon TCP connections.","in":"query","name":"timeoutchild","required":false,"schema":{"example":300,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"save_spamd_config","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update Apache SpamAssassin™ configuration","tags":["Mail","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n save_spamd_config\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/save_spamd_config?api.version=1"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.44"}},"/remote_basic_credential_check":{"get":{"description":"This function checks the SSH credentials on the remote server.\n\n### Authentication\nThere are several methods that you can use to authenticate a transfer session with the remote server.\n\n#### PermitRootLogin=Yes\nThe simplest authentication method is to use the `root` user and password. To do this, the `sshd_config` file on the remote server **must** contain the following value: `PermitRootLogin=Yes`\n\nThe following table displays the correct parameters and values for this authentication method:\n\n| Parameter | Value |\n|-|-|\n| `user` | `root` |\n| `password` | `root`'s password. |\n\nYou can also use the SSH Public Key to authenticate the `root` user. If the SSH Public Key is encrypted, include the SSH Key's passphrase.\n\nThe following table displays the correct parameters and values for this authentication method:\n\n| Parameter | Value if the SSH Key is not encrypted | Value if the SSH Key is encrypted |\n|-|-|-|\n| `user` | `root` | `root` |\n| `sshkey_name` | `root`'s SSH key name. | `root`'s SSH key name. |\n| `sshkey_passphrase` | (none) | `root`'s SSH key passphrase. |\n\n#### PermitRootLogin=No\nMany server administrators do not permit direct root logins on their servers.\n* If the remote server contains `PermitRootLogin=No` in the `sshd_config `file, then you **must** use another user and their password on the remote server, and then escalate to `root`.\n* If the system administrator used WHM's [*Manage Wheel Group Users*](https://go.cpanel.net/whmdocsManageWheelGroupUsers) interface (*WHM >> Home >> Security Center >> Manage Wheel Group Users*) to grant the user `su` access, then you will need to specify `su` and the `root` password.\n* If the user has `sudo` access, you do **not** need the `root` password.\n\nThe following table displays the correct parameters and values for this authentication method:\n\n| Parameter | Value if the user has sudo access | Value if the user has su access |\n|-|-|-|\n| `user` | The user's username. | The user's username. |\n| `password` | The user's password. | The user's password. |\n| `root_escalation_method` | `sudo` | `su` |\n| `root_password` | (none) | `root`'s password. |\n\nYou can also use an SSH Public Key instead of a password to authenticate that user. If the SSH Public Key is encrypted, include the SSH Key's passphrase.\n\nThe following table displays the correct parameters and values for this authentication method:\n\n| Parameter | sudo | su |\n|-|-|-|\n| `user` | The user's username. | The user's username. |\n| `sshkey_name` | The user's SSH key name. | The user's SSH key name. |\n| `sshkey_passphrase` (If encrypted) | The user's SSH key passphrase. | The user's SSH key passphrase. |\n| `root_escalation_method` | `sudo` | `su` |\n| `root_password` | (none) | `root`'s password. |","operationId":"remote_basic_credential_check","parameters":[{"description":"The remote server's hostname or IP address.","example":"192.168.0.0","in":"query","name":"host","required":true,"schema":{"anyOf":[{"description":"A valid IP address.","example":"192.168.0.0","format":"ipv4","type":"string"},{"description":"A valid domain.","example":"remote.example.com","format":"domain","type":"string"}]}},{"description":"The remote server's SSH port number.","in":"query","name":"port","required":false,"schema":{"default":22,"example":22,"maximum":65535,"minimum":1,"type":"integer"}},{"description":"The username to use to connect to the remote server.","in":"query","name":"user","required":true,"schema":{"example":"root","format":"username","type":"string"}},{"description":"The username's password.","in":"query","name":"password","required":false,"schema":{"example":"123456luggage","type":"string"}},{"description":"The escalation method to use to connect to the remote server.\n* `su`\n* `sudo`\n\n**Note:**\n\n Use this parameter if `PermitRootLogin=No` in the remote server's `sshd_config` file.","in":"query","name":"root_escalation_method","required":false,"schema":{"enum":["su","sudo"],"example":"sudo","type":"string"}},{"description":"`root`'s password on the remote server.\n\n**Note:**\n\n Use this parameter if `PermitRootLogin=No` in the remote server's `sshd_config` file and the `root_escalation_method` value is set to `su`.","in":"query","name":"root_password","required":false,"schema":{"example":"123456luggage","type":"string"}},{"description":"The SSH key's name.\n\n**Note:**\n\n SSH keys are available in WHM's *Manage root's SSH Keys* interface (*WHM >> Home >> Security Center >> Manage root’s SSH Keys*).","in":"query","name":"sshkey_name","required":false,"schema":{"example":"FrancisScott","type":"string"}},{"description":"The SSH key's passphrase.\n\n**Note:**\n\n Use this parameter if the SSH Key is encrypted.","in":"query","name":"sshkey_passphrase","required":false,"schema":{"example":"kkwtoowoygidsa","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"output":{"description":"The function call's raw HTML output.","example":"Basic credential check…\nDone\n","type":"string"},"response":{"description":"The function call's response.","example":"basic credential check\n","type":"string"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"remote_basic_credential_check","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"Success","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate remote server's SSH credentials","tags":["Transfers","Transfer Configuration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n remote_basic_credential_check \\\n host='192.168.0.0' \\\n user='root'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/remote_basic_credential_check?api.version=1&host=192.168.0.0&user=root"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"11.44"}},"/delete_ssl_vhost":{"get":{"description":"This function deletes the SSL virtual host.","operationId":"delete_ssl_vhost","parameters":[{"description":"The hostname whose SSL virtual host you'd like to delete.","in":"query","name":"host","required":true,"schema":{"example":"example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"output":{"description":"Shows the status of the deletion.","example":["Deleting the SSL host for example.com","Done."],"items":{"type":"string"},"type":"array"},"removed_vhost_data":{"description":"The virtual host data that the script removed.","items":{"properties":{"ip_port":{"description":"The IP address where the virtual host data resided and its port number.","example":["192.0.2.0","443"],"items":{"type":"string"},"type":"array"},"is_ssl":{"description":"Whether the virtual host was SSL.\n* `1` — The host was SSL.\n- `0` — The host was **not** SSL.","enum":[0,1],"example":1,"type":"integer"},"primary_on_ip_port":{"description":"The domain name that the removed virtual host used.","example":"example.net","format":"domain","type":"string"},"servername":{"description":"The name of the deleted domain.","example":"example.com","format":"domain","type":"string"},"vhost_entry":{"description":"The output text.","example":"<VirtualHost 192.0.2.0 :443>\nServerName example.com\nServerAlias [...]\n","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"metadata":{"properties":{"command":{"description":"The method name called.","example":"delete_ssl_vhost","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete SSL vhost","tags":["SSL","cPanel Account Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"whmapi1 --output=jsonpretty \\\n delete_ssl_vhost \\\n host='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2087/cpsess##########/json-api/delete_ssl_vhost?api.version=1&host=example.com"}],"x-cpanel-api-version":"WHM API 1","x-cpanel-available-version":"82"}},"/enqueue_deferred_ssl_installations":{"get":{"description":"This function adds SSL certificates to the installation queue. This allows you to\ndefer and batch SSL certificate installation.\n\n**Important:**\n\nYou **must** enter the same quantity of `username`, `cab`, `crt`, `key`, and `vhost_name`\nparameters. For example, to add three certificates to the installation queue, enter the\n`username` parameter three times, then enter three `cab`, `crt`, `key`, and `vhost_name`\nparameters.","operationId":"enqueue_deferred_ssl_installations","parameters":[{"description":"The cPanel account username for which to enqueue the SSL certificate installations.\n\n**Note:**\n\nTo add multiple certificates to the installation queue, duplicate or increment the\nparameter name. For example, `username-1`, `username-2`, and `username-3`.","examples":{"multiple":{"summary":"Enqueue multiple SSL certificate installations.","value":"username-1=username1 username-2=username2 username-3=username3"},"multiple-alternative":{"summary":"Enqueue multiple SSL certificate installations.","value":"username=username1 username=username2 username=username3"},"single":{"summary":"Enqueue a single SSL certificate installation.","value":"username"}},"in":"query","name":"username","required":true,"schema":{"type":"string"}},{"description":"The Certificate Authority (CA) bundle's contents.\n\n**Note:**\n\n* We recommend that you enter an empty string. An empty string tells the server to\ndownload the CA bundle automatically.\n* To add multiple certificates to the installation queue, duplicate or increment the\nparameter name. For example, `cab-1`, `cab-2`, and `cab-3`.","examples":{"multiple":{"summary":"Enqueue multiple CA bundles.","value":"cab-1=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ8V8e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE----- cab-2=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ7V7e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE----- cab-3=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE-----"},"multiple-alternative":{"summary":"Enqueue multiple CA bundles.","value":"cab=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ8V8e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE----- cab=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ7V7e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE----- cab=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE-----"},"single":{"summary":"Enqueue a single CA bundle.","value":"-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE-----"}},"in":"query","name":"cab","required":true,"schema":{"type":"string"}},{"description":"The certificate's contents.\n\n**Note:**\n\n To add multiple certificates to the installation queue, duplicate or increment the\n parameter name. For example, `crt-1`, `crt-2`, and `crt-3`.","examples":{"multiple":{"summary":"Enqueue the contents of multiple certificates.","value":"crt-1=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2CFCrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE----- crt-2=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2AZArc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE----- crt-3=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE-----"},"multiple-alternative":{"summary":"Enqueue the contents of multiple certificates.","value":"